RESTful API 是一种规范,它将 web 应用程序划分为资源和操作资源的方法,它允许客户端通过 HTTP 请求从后端服务中获得数据。在处理这些请求时,有些时候服务器无法处理请求,或者请求的数据有问题,这时就需要返回错误代码。下面是一些常见的标准错误代码。
400 错误 Bad Request
当客户端发出的请求不包含正确的参数或请求体格式不正确时,服务器会返回 400 错误。例如,如果客户端需要上传文件,但是没有使用 multipart/form-data 格式来发送请求,则服务器将返回 400 错误。
示例代码:
POST /api/upload HTTP/1.1 Content-Type: application/json { "file": "some content" }
401 错误 Unauthorized
当客户端请求需要身份验证的资源时,但是提供的身份验证信息不正确或不存在时,服务器将返回 401 错误。
示例代码:
GET /api/secure-data HTTP/1.1 Authorization: Basic dXNlcjpwYXNzd29yZA==
403 错误 Forbidden
当客户端请求进行的操作需要特定权限,但是客户端没有该权限时,服务器将返回 403 错误。
示例代码:
DELETE /api/user/1 HTTP/1.1 Authorization: Bearer [token]
404 错误 Not Found
当客户端请求的资源不存在时,服务器将返回 404 错误。
示例代码:
GET /api/user/123 HTTP/1.1
405 错误 Method Not Allowed
当客户端使用没有被允许的请求方法请求资源时,服务器将返回 405 错误。
示例代码:
PUT /api/user/123 HTTP/1.1
406 错误 Not Acceptable
当服务器无法根据客户端请求头部中的 Accept 字段提供请求资源的格式时,服务器将返回 406 错误。
示例代码:
GET /api/user/123 HTTP/1.1 Accept: text/plain
409 错误 Conflict
当客户端请求的资源的状态与服务器上的当前状态不兼容时,服务器将返回 409 错误。最常见的例子是并发修改同一个资源。
示例代码:
PUT /api/user/123 HTTP/1.1 { "email": "john.doe@example.com" }
500 错误 Internal Server Error
当服务器内部出现不能处理的错误时,将返回 500 错误。
示例代码:
GET /api/users HTTP/1.1
结论
RESTful API 的错误处理对于客户端的体验和应用程序的可靠性至关重要,了解这些标准错误代码并使用它们将使你的 API 更加健壮和可靠。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/66f125f46fbf96019736c73b