質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.49%

REST APIにおけるLaravelのバリデーション、例外エラー処理について。

解決済

回答 1

投稿

  • 評価
  • クリップ 1
  • VIEW 6,195

score 20

Laravelにおけるバリデーション処理と例外エラー処理について質問です。
スマートフォン向けアプリを制作しています。

環境は

Laravel 5.5
PHP 7.2.4

また、アルチザンコマンドを使って

App\Http\Controllers\TestController
App\Http\Requests\TestFormRequest
を作成しました。

**TestController**

    public funtion store(Request $request)
    {
        $param = [
            'name'      => $request->json('name'), // あああ
            'password'  => $request->json('password'), // 123456789
        ];
        return new JsonResponse($param);
    }
{
"name": "あああ",
"password": "123456789"
}


と返ります。

次に、例外エラーの際にJson形式で返却したく、App\Exceptions\Handlerのrenderを

    public function render($request, Exception $exception)
    {
//        return parent::render($request, $exception);
        $code    = $exception->getCode();
        $message = $exception->getMessage();

        $error = [
            'code'    => $code,
            'message' => $message,
        ];
        return new JsonResponse($error);
    }


のように書き換えました。

以下の場合ですと

**TestController**

    public funtion store(Request $request)
    {
        throw new \Exception('例外エラーです。', '9999999'); 
    }
{
"code": 9999999,
"message": "例外エラーです。"
}

と返却されるようになりました。ここまでは期待通りなのですが、
バリデーション処理においても同様に例外処理として動作させたいです。

試したこととしては、FormRequestを使ったバリデーションです。

**TestController**
    public function store(TestFormRequest $request)
    {
        //
        $param = [
            'name'      => $request->json('name'), // null
            'password'  => $request->json('password'), // 123456789
        ];
    }

**TestFormRequest**
    public function rules()
    {
        return [
            'name'      => 'required',
            'password'  => 'required|min:8',
        ];
    }
    public function messages()
    {
        return [
            'name.required'     => "aaaaaaaaaa",
            'password.required' => "bbbbbbb",
            'password.min'      => "bbbbbbb",
        ];
    }


インターネットで調べつつ、見よう見まねでこちらのように実装したところ、
nameをnullにすると

{
"code": 0,
"message": "The given data was invalid."
}


と返却されました。
値を入力すると正常に通るので、バリデーションは成功しているようなのです。
こちらのメッセージはValidationExceptionの__constructでデフォルトで表示している文言のようでした。

バリデーションで引っ掛けた場合も

throw new \Exception('名前を入力してください', '123456789');


と同じように、任意のメッセージとエラーコードを返却するような処理を実現したいです。
希望としては、例外はthrowで返すなどしてreturnは1回のみにしたいです。

まとめると、
nameを入力していない場合にバリデーション処理で

{
"code": 123456789,
"message": "名前を入力してください"
}

passwordを7文字以下で入力した場合

{
"code": 123456789,
"message": "パスワードは8文字以上で入力してください"
}


というように同じフォーマットでエラーとして返却したいです。
情報の過不足があればご指摘頂ければと思います。

ご回答の程、よろしくお願い致します。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 1

check解決した方法

+1

Handler.phpのrenderに
if($exception instanceof ValidationException) {
とすることで引っ掛けることができました。
解決しました。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.49%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る