web-dev-qa-db-ja.com

Laravel 5.1でFormRequest戻りjsonを強制する方法は？

私は FormRequest を使用して、スマートフォンアプリからのAPI呼び出しで送信元を検証しています。したがって、検証が失敗した場合は常にFormRequestがjsonを返すようにします。

以下のLaravelフレームワークのソースコードを見て、reqeustがAjaxまたはwantJsonの場合、FormRequestのデフォルトの動作はreturn jsonです。

//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を返します。しかし、ヘッダーを設定せずにデフォルトでjsonをサポートすることにより、APIをリクエストする簡単な方法を提供したいと考えています。そのため、Illuminate\Foundation\Http\FormRequestクラスでFormRequest応答jsonを強制するいくつかのオプションを見つけようとしました。しかし、デフォルトでサポートされているオプションは見つかりませんでした。

解決策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);
    }
}

応答jsonを強制する必要があるかどうかに応じて、protected $forceJsonResponse = false;を設定に追加しました。そして、Request抽象クラスから拡張された各FormRequestで。そのオプションを設定しました。

例：StoreBlogPostRequestを作成し、このFormRequestに$forceJsoResponse=trueを設定して、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この状況で私を助ける方法はありますか？

phplaravellaravel-5laravel-validation
25
Chung

Laravelでこれを行うのが難しいのはなぜでしょうか。結局、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)

32
Bouke Versteegh

私はこの投稿が古いことを知っていますが、リクエストの「Accept」ヘッダーを「application/json」に置き換えるミドルウェアを作成しました。これにより、使用時にwantsJson()関数がtrueを返します。 （これはLaravel 5.2でテストされましたが、5.1でも同じように機能すると思います）

これを実装する方法は次のとおりです。

  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);
    }
}

  2. ミドルウェアを$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
];

  3. 最後に、ミドルウェアと同じようにroutes.phpで使用します。私の場合は次のようになります：

    Route::group(['prefix' => 'api/v1', 'middleware' => ['jsonify']], function() {
    // Routes
});
30
SimonDepelchin

リクエストにX-Request-With：XMLHttpRequestヘッダーまたはコンテンツタイプをapplication/jsonとして受け入れる場合、FormRequestは自動的にステータスが422のエラーを含むjson応答。

enter image description here

2
Afraz Ahmad

ZeroOneの応答 に基づいて、 Form Request validation を使用している場合は、failedValidationメソッドをオーバーライドして、検証が失敗した場合に常にjsonを返すことができます。

このソリューションの良い点は、jsonを返すためにすべての応答をオーバーライドするのではなく、検証の失敗だけをオーバーライドすることです。したがって、他のすべてのPhp例外については、フレンドリーなLaravelエラーページが表示されます。

namespace App\Http\Requests;

use Illuminate\Contracts\Validation\Validator;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Http\Exceptions\HttpResponseException;
use Symfony\Component\HttpFoundation\Response;

class InventoryRequest extends FormRequest
{
    protected function failedValidation(Validator $validator)
    {
        throw new HttpResponseException(response($validator->errors(), Response::HTTP_UNPROCESSABLE_ENTITY));
    }
1
T30

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."
    ],
}
0
ZeroOne