RESTful API 最常见的状态码及其含义

阅读时长 4 分钟读完

RESTful API 是一种基于 HTTP 协议的 Web 开发风格,它具有轻量级、灵活、可伸缩等优点,成为当今大型互联网应用中最为流行的 API 设计风格。在 RESTful API 中,状态码扮演着非常重要的角色。本文将介绍 RESTful API 中最常见的状态码及其含义,帮助开发者更好地使用 RESTful API。

2xx 成功

200 OK

200 OK 是表示请求已成功处理,并返回响应数据的状态码。它在 RESTful API 中是最常见的状态码之一。由于这个状态码几乎是在所有响应中使用的,因此它是默认状态码,通常不需要特别指定。

201 Created

201 Created 表示请求已成功处理,并且在服务器上创建了一个新的资源。可以使用 Location 头指定新资源的位置,例如:

204 No Content

204 No Content 表示请求已成功处理,但服务器没有返回任何内容。一般用于 PUT 或 DELETE 请求,例如:

3xx 重定向

301 Moved Permanently

301 Moved Permanently 表示请求的资源已经被永久移动到新的位置。客户端应该使用新的地址重新发起请求,并将地址记录为新的定位。

302 Found

302 Found 表示请求的资源已经被暂时移动到新的位置。客户端应该使用新的地址重新发起请求,但是地址不应该被视为永久定位。

4xx 客户端错误

400 Bad Request

400 Bad Request 表示客户端发送的请求无效,服务器无法理解。例如,请求中缺少必需参数或参数无效。

401 Unauthorized

401 Unauthorized 表示客户端请求需要身份验证,但未提供有效的凭据。例如,需要通过基本身份验证(Basic Authentication)才能访问该资源。

403 Forbidden

403 Forbidden 表示服务器拒绝客户端请求,因为客户端没有访问权限。例如,访问权限受到了限制,或者客户端需要向服务器提供证书,但服务器拒绝。

404 Not Found

404 Not Found 表示客户端请求的资源不存在。例如,请求的 URL 错误,或者请求的资源已经被删除。

405 Method Not Allowed

405 Method Not Allowed 表示客户端使用了不被支持的 HTTP 方法。例如,客户端提交了 PUT 请求,但该资源只支持 GET 请求。

5xx 服务器错误

500 Internal Server Error

500 Internal Server Error 表示服务器在处理请求时发生了错误,导致无法完成请求。例如,服务器内存溢出、后台程序异常等。

503 Service Unavailable

503 Service Unavailable 表示服务器暂时无法处理请求,例如由于维护或过载。客户端应该在稍后重新尝试请求。

总结

在使用 RESTful API 进行开发时,掌握常见的状态码是非常重要的,它可以帮助你更好地理解服务器端返回的响应信息。在实际开发中,应该根据实际情况选择正确的状态码,并在响应中返回相关信息,以便客户端能够准确地理解响应,并采取正确的行动。使用正确的状态码不仅可以提高应用程序的可用性和可读性,还可以提高应用程序的性能和安全性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/646c1bd5968c7c53b0b29729

纠错
反馈