RESTful API 中 HTTP 状态码使用的规范及意义

什么是 RESTful API？

RESTful API 是一种设计 API 的方式，它是基于 HTTP 协议构建的，通常用于分布式 Web 应用程序中。RESTful API 主要通过定义不同的 HTTP 方法来表示对不同资源的操作，如 GET, POST, DELETE 等。

HTTP 状态码的作用

HTTP 状态码是 Web 服务器返回给客户端的一种语义化的响应标识，标识了客户端请求的处理结果。RESTful API 在进行操作时，在响应时必须使用 HTTP 状态码的某个具体值来传达，以便客户端了解操作是否成功，并有助于客户端进一步处理结果。

常见的 HTTP 状态码：

• 200 OK - 请求成功
• 201 Created - 已创建资源
• 204 No Content - 请求成功，但没有返回任何内容
• 400 Bad Request - 请求无效
• 401 Unauthorized - 未经授权
• 403 Forbidden - 禁止访问
• 404 Not Found - 资源不存在
• 500 Internal Server Error - 服务器内部错误

RESTful API 中 HTTP 状态码的使用规范

在 RESTful API 中，HTTP 状态码的使用应该符合以下几个规范：

1. 用于客户端请求成功的状态码

200 OK 和 201 Created 是客户端请求成功的状态码，200 OK 表示服务器已成功处理请求，201 Created 表示请求已成功，并创建了一项新资源，需要将新资源的 URL 包含在响应中。

示例代码：

HTTP/1.1 201 Created
Location: /resources/newresource
Content-Type: application/json

{
    "id": 123,
    "name": "new resource"
}

2. 用于客户端请求错误的状态码

客户端可以向服务器发送无效的请求，这时应该返回一个错误状态码。常见的错误状态码有 400 Bad Request、401 Unauthorized、403 Forbidden 和 404 Not Found。客户端会根据这些错误状态码采取相应的动作。

示例代码：

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "error": "invalid request"
}

3. 用于服务器内部错误的状态码

服务器内部错误通常表示服务器在处理请求过程中出现了故障。常见的状态码有 500 Internal Server Error。这些错误状态码告诉客户端请求未能成功，并需要服务器管理员进行修复。

示例代码：

HTTP/1.1 500 Internal Server Error
Content-Type: application/json

{
    "error": "server error"
}

总结

HTTP 状态码在 RESTful API 中的使用非常重要，它不仅标识了客户端请求的处理结果，而且也有助于客户端进一步处理结果。RESTful API 开发者应该了解并严格遵守 HTTP 状态码的使用规范，以提高 API 的安全性和可靠性。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/66564999d3423812e4af3c3d