在laravel中以自定义格式返回验证器响应？

Question

I am using validators as

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

    if ($validator->fails()) {
        return response()->json(['error'=>$validator->errors()], 401);            
    }

this gives response in format below:

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

I want response as

{
"error": 1,
"error_msg": "The phone has already been taken."
}

Just one error should show and that too in above format.

Answer 1

For validation to stop after first validation failure, laravel use bail check this . So the rules will be like this

$validator = Validator::make($request->all(), [
    'name' => 'bail|required|max:255',
    'phone' => 'bail|required|max:10|unique:users',
    'email' => 'bail|required|email|max:255|unique:users',
    'password' => 'required|min:6',
]);

For formatting error message, you need to do some change in response

if ($validator->fails()) {
    return response()->json(['error'=> 1, 'error_msg' => $validator->errors()->first()], 400);           
}

You can create a central place to render the validation error so that it will be consistent validation response format through out the application.

Hope this may help you

Answer 2

Use a Form Request to handle the validation:

class CreateUserRequest extends FormRequest {
     public function authorize()
     {
         return true;
     }

     public function rules()
     {
         return [
            'name' => 'required|max:255',
            'phone' => 'required|max:10|unique:users',
            'email' => 'required|email|max:255|unique:users',
            'password' => 'required|min:6',
         ];
     }

     public function messages()
     {
         return [
            'phone.unique' => 'The phone has already been taken.',
            'email.unique'  => 'The email has already been taken.',
         ];
     }
}

Then use it in your controller:

public function create(CreateUserRequest $request)
{
     $user = User::create($request->all());

     return response()->json(['user'=>$user]);
}

This does the validation prior to running the create method and returns the validation error messages for you in a json response.

I would suggest not changing the format of the response, instead adapt to the format returned from laravel as it will always be a uniform shape. That way your client can expect a consistent api response.

And as an aside, validation failures should be a 422 status, not a 401 which are for authentication purposes.