Laravel use Request validation with api

Question

I'm trying to implement validation in my api like this:

public function store(RideUpdateRequest $request)
    {
        $user = JWTAuth::parseToken()->authenticate();

        $ride = Ride::create([
            'user_id'       => $user->id,
            'time'          => $request->time,
            'date'          => $request->date,
            'type_id'       => $request->type_id,
            'location_id'   => $request->location_id,
            'billabletime'  => $request->billabletime
        ]);

        $ride->save();

        return response()->json(['success' => 'Rit succesvol aangemaakt.'], 200);
    }

RideUpdateRequest:

 public function rules()
    {
        return [
            'time'             =>  'required|integer',
            'date'             =>  'required|date',
            'type_id'          =>  'required|integer',
            'location_id'      =>  'required|integer',
            'billabletime'     =>  'required|integer'
        ];
    }

So how could I give a error message back in json (if the request validation fails)? Right now in postman I receive nothing back?

--EDIT--

response:

{
  "billabletime": [
    "The billabletime field is required."
  ]
}

Could I get something like this?:

    {
      "error": {
        "The billabletime field is required."
      }
    }

baikho · Accepted Answer · 2016-12-15 21:07:06Z

13

If you take a look at the FormRequest class, you'll see a response() method defined as something like:

public function response(array $errors)
{
    if ($this->expectsJson()) {
        return new JsonResponse($errors, 422);
    }
    ...
}

So you can either set an Accept: aplication/json request header to comply with the expectsJson condition, or force the default response behavior by sepcifying the response() method in your own RideUpdateRequest class:

public function response(array $errors)
{
    // Always return JSON.
    return response()->json($errors, 422);
}

edited Dec 15, 2016 at 21:07

answered Sep 11, 2016 at 19:17

baikho

5,3884 gold badges43 silver badges49 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Jamie Over a year ago

thanks! One more question right now I receive it not like an object. Is that possible? See my edit for what I mean. Thankyou

baikho Over a year ago

You can try this: return response()->json(['error' => $errors], 400);

Huntelaer · Accepted Answer · 2021-03-12 08:44:50Z

7

In laravel 8 you can control the response by overriding the failedValidation function in your FormRequest class:

use Illuminate\Http\Response;

protected function failedValidation(\Illuminate\Contracts\Validation\Validator $validator)
{
    $response = new Response(['error' => $validator->errors()->first()], 422);
    throw new ValidationException($validator, $response);
}

answered Mar 12, 2021 at 8:44

Huntelaer

891 silver badge7 bronze badges

2 Comments

Shiro Over a year ago

I am checking how Laravel 8 handle with api validation, thanks for the tips

Shiro Over a year ago

Another tip is when u send API request, the header need to add accept:application/json, then it will automatic to return json.

ceejayoz · Accepted Answer · 2016-09-11 20:24:23Z

1

response:

{
  "billabletime": [
    "The billabletime field is required."
  ]
}

Could I get something like this?:

{
  "error": {
    "The billabletime field is required."
  }
}

Laravel uses this format because a) there may be multiple fields that fail validation and b) there may be multiple failures for a particular field.

For example:

{
  "email": [
    "The email field is invalid."
  ],
  "password": [
    "The password field must contain a number.",
    "The password field must contain a special character."
  ]
}

Your "error": { ... } is also unnecessary, because Laravel's validation system sends a 422 Unprocessable Entity status code with the response.

answered Sep 11, 2016 at 20:24

ceejayoz

181k42 gold badges311 silver badges382 bronze badges

2 Comments

Jamie Over a year ago

Oke I understand that. But in my angular app It's very difficult to use that format.

ceejayoz Over a year ago

@Jamie Then you'll need to decide which of the multiple errors get sent back.

Collectives™ on Stack Overflow

Laravel use Request validation with api

3 Answers 3

2 Comments

2 Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

2 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related