T-DOC

在处理 RESTful API 请求时，如果用户请求中出现错误或服务器上发生意外情况，您可以简单地抛出异常来通知用户出了问题。如果可以确定错误的原因（例如，请求的资源不存在），则应考虑抛出异常以及正确的 HTTP 状态代码（例如，yii\web\NotFoundHttpException 表示 404 状态代码）。Yii 将发送响应以及相应的 HTTP 状态代码和文本。Yii 还将在响应正文中包含异常的序列化表示。例如
。例如：

HTTP/1.1 404 Not Found
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
    "name": "Not Found Exception",
    "message": "The requested resource was not found.",
    "code": 0,
    "status": 404
}

以下列表总结了Yii REST框架使用的HTTP状态代码：

200: 好的，一切都按预期进行。
201: 已成功创建资源以响应 POST 请求。 Location 标头包含指向新创建的资源的 URL。
204: 请求已成功处理，响应不包含正文内容（如 DELETE 请求）。
304: 未修改资源。您可以使用缓存版本。
400: 错误的请求。这可能是由用户的各种操作引起的，例如在请求正文中提供无效的 JSON 数据、提供无效的操作参数等。
401: 身份验证失败。
403: 不允许经过身份验证的用户访问指定的 API 终端节点。
404: 请求的资源不存在。
405: 不允许使用方法。请检查标 Allow 头中允许的 HTTP 方法。
415: 不支持的媒体类型。请求的内容类型或版本号无效。
422: 数据验证失败（例如，响应 POST 请求时）。请查看响应正文以获取详细的错误消息。
429: 请求过多。由于速率限制，请求被拒绝。
500: 内部服务器错误。这可能是由内部程序错误引起的。

自定义错误响应

有时，您可能希望自定义默认错误响应格式。例如，您希望始终使用 200 作为 HTTP 状态，并将实际的 HTTP 状态代码作为响应中 JSON 结构的一部分，而不是依赖使用不同的 HTTP 状态来指示不同的错误，如下所示：

HTTP/1.1 200 OK
Date: Sun, 02 Mar 2014 05:31:43 GMT
Server: Apache/2.2.26 (Unix) DAV/2 PHP/5.4.20 mod_ssl/2.2.26 OpenSSL/0.9.8y
Transfer-Encoding: chunked
Content-Type: application/json; charset=UTF-8

{
    "success": false,
    "data": {
        "name": "Not Found Exception",
        "message": "The requested resource was not found.",
        "code": 0,
        "status": 404
    }
}

要实现此目标，您可以在应用程序配置中响应 response 组件 beforeSend 的事件：

return [
    // ...
    'components' => [
        'response' => [
            'class' => 'yii\web\Response',
            'on beforeSend' => function ($event) {
                $response = $event->sender;
                if ($response->data !== null && Yii::$app->request->get('suppress_response_code')) {
                    $response->data = [
                        'success' => $response->isSuccessful,
                        'data' => $response->data,
                    ];
                    $response->statusCode = 200;
                }
            },
        ],
    ],
];

上面的代码将重新格式化响应（对于成功和失败的响应），如在作为 GET 参数传递时 suppress_response_code所解释的那样。

💖喜欢本文档的，欢迎点赞、收藏、留言或转发，谢谢支持！
作者邮箱：zhuzixian520@126.com，github地址：github.com/zhuzixian520

错误处理

错误处理

自定义错误响应