Change laravel errors messages to JSON for API

Question

Is there a way to manipulate or change laravel default error messages into JSON response. I am building an API. The current response that I am getting is

{
    "email": [
        "The email has already been taken."
    ],
    "phone": [
        "The phone has already been taken."
    ]
}

I want it to be like this

{
  "errors": [
    {
      "field": "username",
      "message": "The username field is required."
    },
    {
      "field": "password",
      "message": "The password field is required."
    }
  ]
}




$validator = Validator::make($request->all(), [
            'email' => 'required|string|email|max:50|unique:customers',
            'phone' => 'required|string|max:10|min:10|unique:customers',
            'password' => 'required|string|min:6',
        ]);



        if ($validator->fails()) {
           return response()->json($validator->messages(), 200);
        }

I think he wants to put the errors array inside a errors key. — Phiter
– Phiter, Commented Dec 19, 2017 at 10:52
@Phiter laravel does that automatically.. I cant even access the array/json that is being returned. — Abhijit Borkakoty
– Abhijit Borkakoty, Commented Dec 19, 2017 at 10:57

Amarnasan · Accepted Answer · 2017-12-19 11:23:10Z

2

Extract the errors from the messageBag and format them as you wish:

$errors = [];
foreach($validator->getMessageBag()->toArray() as $key=>$messages) {
    $errors[$key] = $messages[0];
}
return response()->json($errors, 200);

answered Dec 19, 2017 at 11:23

Amarnasan

15.7k7 gold badges35 silver badges38 bronze badges

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

Comments

Niklesh Raut · Accepted Answer · 2017-12-19 11:17:27Z

2

If you get object as you given first example you can change it by for..in loop like this

var response = {
    "email": [
        "The email has already been taken."
    ],
    "phone": [
        "The phone has already been taken."
    ]
};

var allError = [];
for(let i in response){
   allError.push({
      field: i,
      message: response[i][0]
    });
}
var errors = {errors:allError};
console.log(errors);

You should not change from php/laravel, because then you will not be able to show multiple errors for single input.

Also never change base code which can also work for web. You can't think for only API, It can also be used for web.

edited Dec 19, 2017 at 11:17

answered Dec 19, 2017 at 11:00

Niklesh Raut

34.9k17 gold badges82 silver badges112 bronze badges

3 Comments

Amarnasan Over a year ago

Never fix something in local which can be avoided in server.

Niklesh Raut Over a year ago

@Amarnasan : Also never change base code which can also work for web. You can't think for only API, it can also be used for web.

Niklesh Raut Over a year ago

@Amarnasan Neither you nor me completely know the business logic, so I suggest to not change base code from laravel.

Collectives™ on Stack Overflow

Change laravel errors messages to JSON for API

2 Answers 2

Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related