如何显示API请求的自定义vaildation错误消息?

时间:2017-12-14 14:50:27

标签: php laravel api

xib

这是我用于验证发送到API的请求参数的代码。文档仅提供有关表单请求时自定义错误消息的详细信息。

验证错误提供默认消息"给定数据无效"但我想知道哪个参数无效。如何为API请求验证提供自定义验证错误消息?

2 个答案:

答案 0 :(得分:4)

首先,要解耦代码,可以使用Form Request class。来自文档:

  

对于更复杂的验证方案,您可能希望创建一个“表单”   请求“。表单请求是包含的自定义请求类   验证逻辑。

该类包含两种方法:

1 - rules,您指定规则的地方,应返回一系列规则。
返回authorize 2 - boolean,此方法控件允许执行此请求的人员。 默认设置为false ,因此每次通话都会被拒绝。

所以,在你的情况下,它应该是这样的:

首先,在控制台中创建执行此artisan命令的自定义Request类:

php artisan make:request CreateCustomObjectRequest

这将在app/Http/Requests下创建一个新类:

    class CreateCustomObjectRequest extends FormRequest
    {
        /**
         * Determine if the user is authorized to make this request.
         *
         * @return bool
         */
        public function authorize()
        {
            // Implement here your Auth validation, something like:
            return auth()->check();
            // or just return "true" if you want to take care of this anywhere else.
        }

        /**
         * Get the validation rules that apply to the request.
         *
         * @return array
         */
        public function rules()
        {
            return [
                'aadhar' => 'required|digits:12|numeric',
                'name' => 'required|string|max:511',
                'dob' => 'required|date_format:Y-m-d',
                'email' => 'required|email|max:255',
                'address' => 'required|string',
                'insuranceid' => 'required|digits_between:1,15|integer',
                'password' => 'required|min:59|max:60',
            ];
        }
    }

然后,在您的控制器中,我们将使用此自定义Request对象,而不是注入常规Request对象:

use App\Http\Requests\CreateCustomObjectRequest;

// ...

    public function store(CreateCustomObjectRequest $request)
    {
        // the rest of your controller logic.
    }

现在,您真正感兴趣的部分。要以json方式返回错误,您应该在发出请求时添加下一个标题:

Accept: Application/json

此标头将告诉Laravel输出应该是json响应,因此它会将其转换为json。请注意,这仅适用于验证规则以及返回return $someObject之类的对象时。为了进一步定制,你应该使用类似的东西:

return response()->json(['data' => $someObject], 200);

答案 1 :(得分:2)

$validator = Validator::make($request->all(), [
        'password' => [
            'required',
            'confirmed',
            'between:8,55'
        ]
    ]);

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