Laravel 5.4でリクエスト検証リダイレクトを無効にする
そのため、内部プロジェクト用のREST APIを開発しようとしています。フォームリクエストの検証が失敗すると、@ index応答が表示されるという問題があります。
したがって、私には2つのルートがあります。
Route::get('/api/clients', 'ClientController@index');
Route::post('/api/clients', 'ClientController@store');
@indexはすべてのクライアントをリストし、@storeは新しいクライアントを作成します。クライアントに提供されている名前を確認する@storeメソッドにフォームリクエストバリデーターがあります。
バリデータが失敗すると、検証エラーを含むJSON応答が表示されます。しかし、それが起こっていると私が思うのは、検証が失敗したため、同じページにリダイレクトされますが、リダイレクトはGETではなくPOSTであるため、代わりにすべてのクライアントがリストされます。
ヘッダーをajaxリクエストのように設定して、JSONレスポンスを適切に表示できることはわかっていますが、ajaxであるかどうかに関係なく、JSONレスポンスを表示する必要があります。
バリデータのresponseメソッドを無効にしてオーバーライドしようとしましたが、バリデータのwantsJsonメソッドをtrueを返すように設定しようとしましたが、再び無効になりました。
助けをいただければ幸いです。
コードは以下です...
web.php
Route::get('/api/clients', 'ClientController@index');
Route::get('/api/clients/{client}', 'ClientController@show');
Route::post('/api/clients', 'ClientController@store');
Route::put('/api/clients/{id}', 'ClientController@update');
Route::delete('/api/clients/{id}', 'ClientController@delete');
ClientController.php
namespace App\Http\Controllers;
use App\Client;
use App\Http\Requests\ClientRequest;
class ClientController extends Controller
{
/**
* Store a newly created resource in storage.
*
* @param \Illuminate\Http\Request $request
* @return \Illuminate\Http\Response
*/
public function store(ClientRequest $request)
{
return Client::create([
'title' => request('title'),
'user_id' => auth()->id()
]);
}
ClientRequest.php
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class ClientRequest extends FormRequest
{
/**
* 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'
];
}
/**
* Get the failed validation response for the request.
*
* @param array $errors
* @return JsonResponse
*/
public function response(array $errors)
{
dd('exit'); // Doesn't work
}
}
このように試すことができます
以下のように、最初に使用をフォームリクエストに含めます
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Http\Exceptions\HttpResponseException;
その後
protected function failedValidation(Validator $validator) {
throw new HttpResponseException(response()->json($validator->errors(), 422));
}
検証しようとすると、次のように戻ります
{
"title": [
"The title field is required."
]
}
リクエストを行う場合、ヘッダー情報を送信する必要があります。
Accept: application/json
Content-Type: application/json
これで終わりです。laravelはエラーメッセージをリダイレクトせず、JSONとして送信しません。
これを試して
App/Exceptions/Handler.phpファイルを開きます
使用を含む
use Illuminate\Validation\ValidationException;
そしてメソッドを追加します
/**
* Create a response object from the given validation exception.
*
* @param \Illuminate\Validation\ValidationException $e
* @param \Illuminate\Http\Request $request
* @return \Symfony\Component\HttpFoundation\Response
*/
protected function convertValidationExceptionToResponse(ValidationException $e, $request)
{
if ($e->response) {
return $e->response;
}
return response()->json($e->validator->errors()->getMessages(), 422);
}
今、あなたはajaxリクエストのような標準的なvalidationFailureレスポンスを得ることができます
上書きするApiFormRequest whoを作成したところ FormRequest::failedValidation このようなメソッド：
<?php
// app/Http/Requests/ApiFormRequest.php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
use Illuminate\Http\Exceptions\HttpResponseException;
use Illuminate\Contracts\Validation\Validator;
class ApiFormRequest extends FormRequest
{
protected function failedValidation(Validator $validator): void
{
$jsonResponse = response()->json(['errors' => $validator->errors()], 422);
throw new HttpResponseException($jsonResponse);
}
}
次に、単にこのように使用します
<?php
namespace App\Http\Requests;
use Illuminate\Foundation\Http\FormRequest;
class ClientRequest extends ApiFormRequest
{
// ...
Acceptヘッダーにデフォルトでapplication/jsonを含めるように（APIリクエストのみ）ミドルウェアを作成しました。
/**
* Ensures the default Accept header is application/json
*/
class DefaultApiAcceptJson
{
public function handle(Request $request, \Closure $next)
{
$acceptHeader = $request->headers->get('Accept');
if (!Str::contains($acceptHeader, 'application/json')) {
$newAcceptHeader = 'application/json';
if ($acceptHeader) {
$newAcceptHeader .= "/$acceptHeader";
}
$request->headers->set('Accept', $newAcceptHeader);
}
return $next($request);
}
}
この方法では、Webインデックスページへのリダイレクトではなく、常に検証エラーのJSON応答を取得します。
単にこの特性を使用して、FormRequest検証後のリダイレクトを防止します。次の特性は、次のようないくつかの有用なパブリックメソッドももたらします。
validatorPasses()validatorFails()validatorErrors()respondWithErrorsJson(int $code = 422)redirectWithErrors()-デフォルトのLaravel FomrRequestの動作を復元します
特性
namespace App\Http\Requests;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Http\Exceptions\HttpResponseException;
use Illuminate\Support\MessageBag;
use Illuminate\Validation\ValidationException;
trait PreventsRedirectWhenFailedTrait
{
/**
* Default self::failedValidation() Laravel behavior flag.
*
* @var bool
*/
private $defaultFailedValidationRestored = false;
/**
* Check for validator success flag.
*
* @return bool
*/
public function validatorPasses(): bool
{
return !$this->validatorFails();
}
/**
* Check for validator fail flag.
*
* @return bool
*/
public function validatorFails(): bool
{
return $this->getValidatorInstance()->fails();
}
/**
* @return MessageBag
*/
public function validatorErrors(): MessageBag
{
return $this->getValidatorInstance()->errors();
}
/**
* Respond with validator errors in JSON format.
*
* @param int $code
*/
public function respondWithErrorsJson(int $code = 422): void
{
if ($this->validatorFails()) {
throw new HttpResponseException(
response()->json(['errors' => $this->getValidatorInstance()->errors()], $code)
);
}
}
/**
* Restore and apply default self::failedValidation() method behavior.
*
* @throws ValidationException
*/
public function redirectWithErrors(): void
{
$this->defaultFailedValidationRestored = true;
$this->failedValidation($this->getValidatorInstance());
}
/**
* Handle a failed validation attempt.
*
* @param \Illuminate\Contracts\Validation\Validator $validator
* @return void
*
* @throws \Illuminate\Validation\ValidationException
*/
protected function failedValidation(Validator $validator): void
{
if ($this->defaultFailedValidationRestored) {
throw (new ValidationException($validator))
->errorBag($this->errorBag)
->redirectTo($this->getRedirectUrl());
}
}
}
使用例：
namespace App\Http\Requests;
use Auth;
use Illuminate\Foundation\Http\FormRequest;
class AuthRequest extends FormRequest
{
use PreventsRedirectWhenFailedTrait;
/**
* Determine if the user is authorized to make this request.
*
* @return bool
*/
public function authorize(): bool
{
return Auth::guest();
}
/**
* Get the validation rules that apply to the request.
*
* @return array
*/
public function rules(): array
{
return [
'email' => 'required|email|exists:users',
'password' => 'required',
'remember_me' => 'integer',
];
}
}
コントローラの内部：
public function authenticate(AuthRequest $request)
{
if ($request->validatorPasses()) {
$data = $request->validated();
/* your logic */
} else {
$errorBag = $request->validatorErrors();
}
// or
if ($request->validatorFails()) {
// your logic
}
}
これがお役に立てば幸いです。
バリデーターエラーを扱う2つの方法があります、私の提案は2番目の方法です：
1。最初の方法は、検証が失敗した場合（コントローラー内）にエラーを返すだけです。例：
try {
request()->validate([
'input1' => 'required',
'input2' => 'string|min:5',
]);
} catch (\Illuminate\Validation\ValidationException $e){
return response('The given data was invalid.', 400);
}
便利で清潔。
2。 2番目の方法は、次のように（コントローラー内の）ユーザーに完全なエラーを表示します。
use Illuminate\Support\Facades\Validator;
$validator = Validator::make(request()->all(), [
'id' => 'required|integer',
'description' => 'string'
]);
// return array of errors to client with status code 400
if ($validator->fails())
return response($validator->messages()->toArray(), 400);