了解 RESTful API 中的 HTTP 状态码

在前端开发中，经常需要和后端进行数据交互，其中 RESTful API 是比较常用的一种方式。在这个过程中，HTTP 状态码起到了非常重要的作用。本文将深入讲解 HTTP 状态码在 RESTful API 中的应用，希望能为开发者提供一些指导意义。

什么是 HTTP 状态码

HTTP 状态码是服务器响应客户端请求时的状态标识。当客户端发送请求到服务器后，服务器会根据请求的处理结果回复一个状态码，通知客户端请求的处理结果。HTTP 状态码的格式通常是一个 3 位的数字，这个数字被分为 5 个类别，每个类别代表了不同的状态码含义。

以下是常见的 HTTP 状态码分类：

• 1XX：信息类状态码，指示客户端应该继续发送请求。
• 2XX：成功类状态码，指示服务器成功接收并处理了客户端请求。
• 3XX：重定向类状态码，指示客户端需要执行额外的操作才能完成请求。
• 4XX：客户端错误类状态码，指示客户端请求有错误或无法访问请求的资源。
• 5XX：服务器错误类状态码，指示服务器在处理请求时发生了错误。

下面是一些常见的 HTTP 状态码：

• 200 OK：表示服务器成功处理了客户端请求，并返回了请求的资源。
• 201 Created：表示服务器成功创建了新资源，并返回新资源的信息。
• 204 No Content：表示服务器成功处理了请求，但没有返回任何内容。
• 301 Moved Permanently：表示请求的资源已经永久移动到一个新的 URL。
• 400 Bad Request：表示客户端请求有错误，服务器无法处理请求。
• 401 Unauthorized：表示客户端请求的资源需要身份验证，但客户端未提供身份验证信息。
• 403 Forbidden：表示客户端请求的资源被服务器禁止访问。
• 404 Not Found：表示客户端请求的资源不存在。
• 500 Internal Server Error：表示服务器在处理请求时遇到了一些问题。

HTTP 状态码在 RESTful API 中的应用

在 RESTful API 的交互中，HTTP 状态码通常用来指示服务器对请求的处理结果。RESTful API 通常定义了一些标准的状态码，对于不同的操作类型，使用不同的状态码来指示操作结果。

下面是一些常用的 RESTful API 状态码：

• 200 OK：表示请求成功，服务器响应了请求的资源。
• 201 Created：表示请求成功，服务器创建了新的资源，响应了新资源的信息。
• 204 No Content：表示请求成功，服务器处理了请求，但没有返回任何信息。
• 400 Bad Request：表示请求有错误，服务器无法处理请求。
• 401 Unauthorized：表示请求需要身份验证，但没有提供身份验证信息。
• 403 Forbidden：表示请求被服务器禁止访问。
• 404 Not Found：表示请求的资源不存在。
• 409 Conflict：表示冲突，通常在 PUT 或 POST 操作更新资源时使用。
• 500 Internal Server Error：表示服务器在处理请求时遇到了一些问题。

在进行 RESTful API 接口开发时，良好的状态码设计可以为开发者提供清晰的指导和参考。下面是一些状态码的实际应用例子：

GET 请求

对于 GET 请求，通常会返回 200 OK 状态码。

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "张三",
}

当请求的资源不存在时，应当返回 404 Not Found 状态码。

HTTP/1.1 404 Not Found

POST 请求

对于 POST 请求，通常会返回 201 Created 状态码，表示新资源创建成功。

HTTP/1.1 201 Created
Location: /api/users/1
Content-Type: application/json

{
    "id": 1,
    "name": "张三",
}

如果客户端请求的数据不正确，则应当返回 400 Bad Request 状态码。

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

{
    "message": "请求数据格式错误"
}

PUT 请求

对于 PUT 请求，通常会返回 200 OK 状态码，表示更新成功。

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": 1,
    "name": "李四",
}

如果请求的资源不存在，则可以返回 404 Not Found 状态码。

HTTP/1.1 404 Not Found

当请求的资源存在，但客户端请求的数据不正确时，应当返回 400 Bad Request 状态码。

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

{
    "message": "请求数据格式错误"
}

DELETE 请求

对于 DELETE 请求，如果删除成功，通常会返回 204 No Content 状态码。

HTTP/1.1 204 No Content

如果请求的资源不存在，则可以返回 404 Not Found 状态码。

HTTP/1.1 404 Not Found

总结

HTTP 状态码在 RESTful API 的设计和开发中起着非常重要的作用。良好的状态码设计可以为开发者提供清晰的指导和参考，使得开发工作更加高效和有序。希望本文能为大家提供一些关于 HTTP 状态码在 RESTful API 中应用的实际指导感悟。

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