介绍

REST API旨在在HTTP / HTTPS协议之上工作。对于从客户端发送的每个请求，服务器都会发送相应的HTTP响应。从服务器发回的HTTP响应应包含以下信息：

• 状态-包含协议版本和状态代码
• 响应标题-包含状态中无法容纳的其他信息。响应标头的末尾用空行分隔
• 可选的消息正文-按照惯例，成功的HTTP请求将导致HTTP响应，其中包含包含客户端请求的信息的消息正文。如果有任何错误，则消息正文可能包含发生错误的详细信息。

我们将重点介绍HTTP状态代码。

什么是HTTP状态代码？

HTTP状态代码是作为服务器HTTP响应状态的一部分发送的三位数字值。状态代码给出了对服务器的请求是否成功的想法。HTTP状态代码的第一位数字给出了接收的响应类别的概念。国际号码分配机构（IANA）根据RFC 7231中提到的标准维护HTTP状态代码的目录。

HTTP状态码的类型

在本节中，我们将详细了解有关HTTP状态代码的更多信息。

1xx码

以1开头的HTTP状态代码通知客户端已接收到请求，并且正在服务器端对其进行处理。如果请求涉及复杂且耗时的计算，则有时服务器可能需要一段时间来处理请求。在这种情况下，最好通知客户端应该等待一段时间才能到达响应。但是，如果客户端基于HTTP / 1.0且与HTTP / 1.1不兼容，则应避免这种中间响应。

2xx码

以2开头的HTTP状态代码通知客户端请求已成功。此类别中的一些常用状态代码为：

• 200 OK-这是标准状态代码，作为成功HTTP请求的响应的一部分发送。通常，一个GET请求将带有此状态码的响应。
• 201已创建-表示HTTP请求成功，并且在服务器端创建了新的实体或资源。
• 204 NO CONTENT（无内容）—表示HTTP请求成功，但没有内容作为消息正文的一部分发送。

3xx码

以3开头的状态代码会通知客户端需要URL重定向。查看响应代码，用户应采取其他步骤来获取更多信息。此类别中的一些常用状态代码为：

• 永久移动的301 —在要访问的域或子域发生更改的情况下使用。收到对此消息的响应后，客户端应使用作为Location标头的一部分发送的新URL。
• 307 TEMPORARY REDIRECT（临时重定向）—通知客户端需要将相同的请求发送到其他URL。但是任何后续请求都可以发送到旧网址
• 308永久重定向-通知客户端所有将来的请求都应使用另一个URL进行重复。301和308之间的区别在于，在后一种情况下，关联的HTTP方法不会更改。

4xx码

此类状态代码会通知客户端，由于从客户端发送请求的方式，请求未成功。好的做法是将状态消息作为响应主体的一部分，以将当前请求出了什么问题通知客户端。此类别中的一些常用状态代码为：

• 400 BAD REQUEST-当客户端在服务器端发送不符合预期格式的请求时发送。例如，如果客户端将无效参数作为POST请求的一部分发送，则可以发送带有此状态代码的响应。
• 401 UNAUTHORIZED（未授权）—如果客户端作为请求的一部分发送了无效的用户名/密码凭据，则此状态代码将作为响应的一部分发送，以通知客户端授权失败。
• 403 FORBIDDEN —如果作为请求的一部分发送的用户凭据是无权查看所请求信息的用户的凭据，则将从服务器端发送带有此状态代码的响应。
• 404 NOT FOUND —如果请求的资源不存在，则服务器将使用此响应代码来通知客户端有关此资源的信息。
• 405不允许使用方法-如果URL不支持所请求的方法，则发送该方法。
• 409 CONFLICT（冲突）—如果由于服务器端的某些冲突（例如，来自多个源的对同一资源的同时编辑请求）而无法处理请求，则将其作为响应发送。

5xx码

如果响应代码以5开头，则它会由于服务器端的错误而通知请求失败。此类别中的一些常用状态代码为：

• 500 INTERNAL SERVER ERROR（内部服务器错误）—为服务器错误发送的标准和通用错误代码。
• 502 BAD GATEWAY（错误的网关）—表示服务器充当网关或代理时，从上游服务器收到无效的响应。
• 503 SERVICE UNAVAILABLE —如果服务器忙于处理其他请求，则返回此状态代码。它应该是临时的，并且一旦减少服务器负载，随后的重试可能会导致成功的响应。

在REST API中使用正确的HTTP状态代码

GET请求

• 成功的GET请求应返回200 OK，作为HTTP响应的一部分。
• 如果请求资源不存在，则应返回404 NOT FOUND。
• 如果只有授权用户可以查看数据，并且作为请求的一部分发送的凭据是错误的，则应发送401 UNAUTHORIZED状态代码。
• 如果用户无权查看数据，则应发送403 FORBIDDEN状态代码。

POST请求

成功的POST请求将在服务器端创建一个新资源。因此，应在响应正文中发送201 CREATED作为状态代码。新资源的位置应作为HTTP响应中位置标头的一部分发送。如果POST请求失败，则发送适当的响应代码将使客户端知道出了什么问题。

• 如果在服务器端未实现POST方法，则应使用405 METHOD NOT ALLOWED NOT ALLOWED通知客户端。
• 如果客户端在POST请求中发送了错误的数据，则应使用400 BAD REQUEST。
• 如果客户端使用无效的凭据，则应使用401 UNAUTHORIZED状态代码。
• 如果客户使用了无权创建新资源的用户凭证，则应使用403 FORBIDDEN。

PUT请求

成功的PUT请求将修改现有资源，并发送204 NO CONTENT作为状态代码。如果资源不可用，它将创建一个新资源并在响应正文中发送201 CREATED作为状态码。

如果未实施PUT方法，则应使用405 METHOD NOT ALLOWED。

• 如果客户端发送的数据无效，则应使用400 BAD REQUEST。
• 如果客户端使用无效的凭据，则应使用401 UNAUTHORIZED状态代码。
• 如果客户端使用了无权修改资源的用户凭据，则应使用403 FORBIDDEN。

DELETE请求

成功的DELETE请求将删除现有资源并发送204 NO CONTENT作为状态码。

• 如果资源不存在，则应发送404 NOT FOUND作为响应状态代码。
• 如果未实现DELETE方法，则应将405 METHOD NOT ALLOWED用作响应代码。
• 如果客户端使用无效的凭据，则应使用401 UNAUTHORIZED状态代码。
• 如果客户端使用了无权删除资源的用户凭据，则应使用403 FORBIDDEN。

在所有标准方法中，如果存在服务器错误，则应返回适当的5xx状态代码作为响应代码的一部分。

结论

在本教程中，我们了解了HTTP状态代码以及如何在REST API中使用它们。对于给定的请求使用正确的状态代码很重要，因为这是客户端了解发送到服务器的请求出了什么问题的标准方式。

参考

An Introduction To API Return Codes