常用HTTP状态码

根据以下几个方面来设计RESTFful API

资源路径（URI）、HTTP动词、过滤信息、状态码、错误处理、返回结果。

资源路径：在URI中一般不涉及动词。比如获取用户信息可以使用https://www.cnblogs.com/v1/user，该请求为get请求，如果要删除则使用delete。

HTTP动词：

　　　　GET：从服务器取出资源。 /user/ID获取指定用户的信息。

　　　　POST：在服务器新建一个资源。/user 新建一个用户。

　　　　PUT：在服务器更新资源（客户端提供改变后的完整资源）。/user/ID 更新指定用户的信息。

　　　　DELETE:从服务器删除资源。 user/ID 删除指定用户的信息。

过滤信息：如果数据太多，服务器端不可能一次性将所有数据都返回给客户端，API应该提供参数，过滤返回结果。?page=2&per_page=100#

状态码：服务器向用户返回的状态码和提示信息，使用标准的HTTP状态码。

　　　　200 OK 客户端请求成功，服务器端成功返回用户请求的数据。（该操作是幂等的）　　　　

　　　　201 CREATED 新建或修改数据成功。

　　　　204 NO CONTENT 删除数据成功。

　　　　400 BAD REQUEST 用户发出的请求有错误。（该操作是幂等的）

　　　　401 Unauthorized 表示该用户没有认证，无法进行当前操作。

　　　　403 Forbidden 表示用户访问是被禁止的。

　　　　404 Not Found 表示请求的资源不存在。

　　　　405 Method not allowed 表示请求的资源的时候，使用了不被支持的HTTP方法。

　　　　409 Conflict 表示请求与服务器当前状态冲突（客户端与服务器都要对服务器上的文件进行写的操作）。处理并非问题。

　　　　422 Unprocesable Entity 当创建一个对象时，发生了一个验证错误。Mostate.Isvalid==false的时候（账号或密码错误等……）

　　　　500 INTERNAL SERVER ERROR服务器发生错误，用户将无法判断发出的请求是否成功。

信息响应(100–199)
1xx（临时响应）：表示临时响应并需要请求者继续执行操作的状态代码。
100 （继续）： 请求者应当继续提出请求。 服务器返回此代码表示已收到请求的第一部分，正在等待其余部分。
101 （切换协议）： 请求者已要求服务器切换协议，服务器已确认并准备切换。 成功响应(200–299)
2xx （成功）：表示成功处理了请求的状态代码。
200 （成功）： 服务器已成功处理了请求。 通常，这表示服务器提供了请求的网页。
201 （已创建） ：请求成功并且服务器创建了新的资源。
202 （已接受）：服务器已接受请求，但尚未处理。
203 （非授权信息）：服务器已成功处理了请求，但返回的信息可能来自另一来源。
204 （无内容） ：服务器成功处理了请求，但没有返回任何内容。
205 （重置内容） ：服务器成功处理了请求，但没有返回任何内容。
206 （部分内容）：服务器成功处理了部分 GET 请求。 重定向(300–399)
3xx （重定向） ：表示要完成请求，需要进一步操作。 通常，这些状态代码用来重定向。
300 （多种选择）： 针对请求，服务器可执行多种操作。 服务器可根据请求者 (user agent) 选择一项操作，或提供操作列表供请求者选择。
301 （永久移动）：请求的网页已永久移动到新位置。 服务器返回此响应（对 GET 或 HEAD 请求的响应）时，会自动将请求者转到新位置。
302 （临时移动）：服务器目前从不同位置的网页响应请求，但请求者应继续使用原有位置来进行以后的请求。
303 （查看其他位置）:请求者应当对不同的位置使用单独的 GET 请求来检索响应时，服务器返回此代码。
304 （未修改）:自从上次请求后，请求的网页未修改过。 服务器返回此响应时，不会返回网页内容。
305 （使用代理）:请求者只能使用代理访问请求的网页。 如果服务器返回此响应，还表示请求者应使用代理。
307 （临时重定向）: 服务器目前从不同位置的网页响应请求，但请求者应继续使用原有位置来进行以后的请求。 客户端错误(400–499)
4xx（请求错误）:这些状态代码表示请求可能出错，妨碍了服务器的处理。
400 （错误请求）:服务器不理解请求的语法。
401 （未授权）:请求要求身份验证。 对于需要登录的网页，服务器可能返回此响应。
403 （禁止）:服务器拒绝请求。
404 （未找到）: 服务器找不到请求的网页。
405 （方法禁用）:禁用请求中指定的方法。
406 （不接受）:无法使用请求的内容特性响应请求的网页。
407 （需要代理授权）:此状态代码与 401（未授权）类似，但指定请求者应当授权使用代理。
408 （请求超时）:服务器等候请求时发生超时。
409 （冲突）:服务器在完成请求时发生冲突。 服务器必须在响应中包含有关冲突的信息。
410 （已删除）:如果请求的资源已永久删除，服务器就会返回此响应。
411 （需要有效长度）:服务器不接受不含有效内容长度标头字段的请求。
412 （未满足前提条件）:服务器未满足请求者在请求中设置的其中一个前提条件。
413 （请求实体过大）:服务器无法处理请求，因为请求实体过大，超出服务器的处理能力。
414 （请求的 URI 过长）:请求的 URI（通常为网址）过长，服务器无法处理。
415 （不支持的媒体类型）:请求的格式不受请求页面的支持。
416 （请求范围不符合要求）:如果页面无法提供请求的范围，则服务器会返回此状态代码。
417 （未满足期望值）:服务器未满足"期望"请求标头字段的要求。 服务器错误 (500–599)
5xx（服务器错误）:这些状态代码表示服务器在尝试处理请求时发生内部错误。 这些错误可能是服务器本身的错误，而不是请求出错。
500 （服务器内部错误）:服务器遇到错误，无法完成请求。
501 （尚未实施）:服务器不具备完成请求的功能。 例如，服务器无法识别请求方法时可能会返回此代码。
502 （错误网关）:服务器作为网关或代理，从上游服务器收到无效响应。
503 （服务不可用）:服务器目前无法使用（由于超载或停机维护）。 通常，这只是暂时状态。
504 （网关超时）:服务器作为网关或代理，但是没有及时从上游服务器收到请求。
505 （HTTP 版本不受支持）:服务器不支持请求中所用的 HTTP 协议版本。

 

错误处理：如果状态码是4XX或者是5XX，应该向用户返回出错信息，一般来说，返回的信息中将error作为键名，出错信息作为键值即可。

　　　　例如：{"error":"参数错误"}

返回结果：针对不同操作，服务器向用户返回的结果应该符合以下规范；

　　　　GET /users ：返回资源对象的列表（数组）。

　　　　GET /users/id  ：返回单个资源对象。

　　　　POST /users  ：返回新生成的资源对象。

　　　　PUT  /users/id  ：返回被更新的完整的资源对象。

　　　　DELETE  /users/id  ：返回一个空文档（此时的状态码是204）。

 

 更多状态码：https://www.cnblogs.com/vichin/p/12182501.html