如何显示 API 请求的自定义验证错误消息？

Question

            try{
                $request->validate([
                    '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',
                ]);
                }
            catch(Exception $error){
                    $message = $error->getMessage();
                    $status_code=400;
                    return response()->json(["message" => $message,"status_code" => $status_code]);
                }

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

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

Answer 1

首先，为了解耦代码，您可以使用Form Request 类。来自文档：

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

该类包含两个方法：

1 - rules，您指定规则的地方，它应该返回一个规则数组。
2 - authorize返回一个boolean，此方法控制允许谁执行此请求。默认设置为false，因此每个呼叫都会被拒绝。

所以，就你的情况而言，它应该是这样的：

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

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);