Как заставить FormRequest возвратить json в Laravel 5.1?

Я использую FormRequest для проверки, от которого отправляется вызов API из моего приложения для смартфонов. Итак, я хочу, чтобы FormRequest всегда возвращал json, когда проверка не удалась.

Я увидел следующий исходный код структуры Laravel, поведение по умолчанию FormRequest - это возврат json, если reqeust - Ajax или wantJson.

//Illuminate\Foundation\Http\FormRequest class
/**
 * Get the proper failed validation response for the request.
 *
 * @param  array  $errors
 * @return \Symfony\Component\HttpFoundation\Response
 */
public function response(array $errors)
{
    if ($this->ajax() || $this->wantsJson()) {
        return new JsonResponse($errors, 422);
    }

    return $this->redirector->to($this->getRedirectUrl())
                                    ->withInput($this->except($this->dontFlash))
                                    ->withErrors($errors, $this->errorBag);
}

Я знал, что могу добавить Accept= application/json в заголовок запроса. FormRequest вернет json. Но я хочу предоставить более простой способ запросить мой API, поддерживая json по умолчанию без установки какого-либо заголовка. Итак, я попытался найти некоторые опции, чтобы принудительно выполнить ответ FormRequest json в классе Illuminate\Foundation\Http\FormRequest. Но я не нашел никаких опций, которые поддерживаются по умолчанию.

Решение 1: Запрос на перезапись Аннотация Класс

Я попытался перезаписать абстрактный класс запроса приложения следующим образом:

<?php

namespace Laravel5Cg\Http\Requests;

use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Http\JsonResponse;

abstract class Request extends FormRequest
{
    /**
     * Force response json type when validation fails
     * @var bool
     */
    protected $forceJsonResponse = false;

    /**
     * Get the proper failed validation response for the request.
     *
     * @param  array  $errors
     * @return \Symfony\Component\HttpFoundation\Response
     */
    public function response(array $errors)
    {
        if ($this->forceJsonResponse || $this->ajax() || $this->wantsJson()) {
            return new JsonResponse($errors, 422);
        }

        return $this->redirector->to($this->getRedirectUrl())
            ->withInput($this->except($this->dontFlash))
            ->withErrors($errors, $this->errorBag);
    }
}

Я добавил protected $forceJsonResponse = false; в настройку, если нам нужно принудительно ответить json или нет. И в каждом FormRequest, который простирается от абстрактного класса Request. Я установил этот параметр.

Например: я создал StoreBlogPostRequest и установил $forceJsoResponse=true для этого FormRequest и сделал его ответом json.

<?php

namespace Laravel5Cg\Http\Requests;

use Laravel5Cg\Http\Requests\Request;

class StoreBlogPostRequest extends Request
{

    /**
     * Force response json type when validation fails
     * @var bool
     */

     protected $forceJsonResponse = true;
    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize()
    {
        return true;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return array
     */
    public function rules()
    {
        return [
            'title' => 'required|unique:posts|max:255',
            'body' => 'required',
        ];
    }
}

Решение 2: добавьте заголовок запроса промежуточного программного обеспечения и изменения силы

Я создаю промежуточное программное обеспечение, подобное следующим:

namespace Laravel5Cg\Http\Middleware;

use Closure;
use Symfony\Component\HttpFoundation\HeaderBag;

class AddJsonAcceptHeader
{
    /**
     * Add Json HTTP_ACCEPT header for an incoming request.
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $request->server->set('HTTP_ACCEPT', 'application/json');
        $request->headers = new HeaderBag($request->server->getHeaders());
        return $next($request);
    }
}

Это работает. Но мне интересно, хорошо ли это решение? И есть ли способ Laravel помочь мне в этой ситуации?

Ответ 1

Это пугает мой разум, почему так трудно сделать в Ларавеле. В конце концов, исходя из вашей идеи переопределить класс Request, я придумал это.

app/Http/Requests/ApiRequest.php

<?php

namespace App\Http\Requests;


class ApiRequest extends Request
{
    public function wantsJson()
    {
        return true;
    }
}

Затем на каждом контроллере просто пройдите \App\Http\Requests\ApiRequest

public function index(ApiRequest $request)

Ответ 2

Я знаю, что этот пост довольно старый, но я только что создал Middleware, который заменяет заголовок "Accept" запроса на "application/json". Это заставляет wantsJson() возвращать true при использовании. (Это было проверено в Laravel 5.2, но я думаю, что это работает так же, как в 5.1)

Вот как вы это реализуете:

Создайте файл app/Http/Middleware/Jsonify.php

namespace App\Http\Middleware;

use Closure;

class Jsonify
{

    /**
     * Change the Request headers to accept "application/json" first
     * in order to make the wantsJson() function return true
     *
     * @param  \Illuminate\Http\Request  $request
     * @param  \Closure  $next
     * 
     * @return mixed
     */
    public function handle($request, Closure $next)
    {
        $request->headers->set('Accept', 'application/json');

        return $next($request);
    }
}

Добавьте промежуточное программное обеспечение в таблицу $routeMiddleware вашего файла app/Http/Kernel.php

protected $routeMiddleware = [
    'auth'       => \App\Http\Middleware\Authenticate::class,
    'guest'      => \App\Http\Middleware\RedirectIfAuthenticated::class,
    'jsonify'    => \App\Http\Middleware\Jsonify::class
];

Наконец, используйте его в вашем routes.php как если бы вы использовали любое промежуточное программное обеспечение. В моем случае это выглядит так:
```
Route::group(['prefix' => 'api/v1', 'middleware' => ['jsonify']], function() {
    // Routes
});
```

Ответ 3

если ваш запрос имеет заголовок X-Request-With: XMLHttpRequest или принимает тип контента как application/json FormRequest автоматически вернет ответ json, содержащий ошибки со статусом 422.

Ответ 4

я просто переопределить функцию failedValidation

protected function failedValidation(Validator $validator)
{
        if ($this->wantsJson()) {
            // flatten all the message
            $collection  = collect($validator->errors())->flatten()->values()->all();
            throw new HttpResponseException(Response::error('Validation Error', $collection));
        }

        parent::failedValidation($validator);
}

Итак, выходной образец:

{
    "error": true,
    "message": "Validation Error",
    "reference": [
        "The device id field is required.",
        "The os version field is required.",
        "The apps version field is required."
    ],
}