Api 最佳实践

Created: November-22, 2018

状态代码

1xx：信息

信息	描述	详细描述
`100`	继续	服务器已收到请求标头，客户端应继续发送请求正文
`101`	切换协议	请求者已要求服务器切换协议
`103`	检查站	用于可恢复请求提议以恢复中止的 PUT 或 POST 请求

2xx：成功

信息	描述	详细描述
`200`	好	请求正常（这是成功 HTTP 请求的标准响应）
`201`	创建	请求已完成，并创建了新资源
`202`	公认	该请求已被接受处理，但处理尚未完成
`203`	非权威信息	请求已成功处理，但返回的信息可能来自其他来源
`204`	无内容	请求已成功处理，但未返回任何内容
`205`	重置内容	请求已成功处理，但未返回任何内容，并要求请求者重置文档视图
`206`	部分内容	由于客户端发送的范围标头，服务器仅提供部分资源

3xx：重定向

信息	描述	详细描述
`300`	多种选择	链接列表。用户可以选择链接并转到该位置。最多五个地址
`301`	永久移动	请求的页面已移至新 URL
`302`	发现	请求的页面已临时移动到新 URL
`303`	见其他	请求的页面可以在不同的 URL 下找到
`304`	没有修改	表示自上次请求后未请求修改请求的页面
`306`	切换代理	不再使用
`307`	临时重定向	请求的页面已临时移动到新 URL
`308`	恢复不完整	用于可恢复请求提议以恢复中止的 PUT 或 POST 请求

4xx：客户端错误

信息	描述	详细描述
`400`	错误的请求	由于语法错误，无法满足请求
`401`	擅自	该请求是合法请求，但服务器拒绝响应它。用于可以进行身份验证但已失败或尚未提供的情况
`402`	需要付款	保留供将来使用
`403`	被禁止	该请求是合法请求，但服务器拒绝响应它
`404`	未找到	找不到请求的页面，但将来可能会再次提供
`405`	方法不允许	使用该页面不支持的请求方法请求页面
`406`	不能接受的	服务器只能生成客户端不接受的响应
`407`	需要代理验证	客户端必须首先使用代理进行身份验证
`408`	请求超时	服务器超时等待请求
`409`	冲突	由于请求中存在冲突，无法完成请求
`410`	飘	请求的页面不再可用
`411`	长度要求	内容长度未定义。没有它，服务器将不接受请求
`412`	前提条件失败	请求中给出的前提条件由服务器评估为 false
`413`	请求的实体太大	服务器不接受请求，因为请求实体太大
`414`	请求 URI 太长	服务器不接受请求，因为 URL 太长。将 POST 请求转换为具有长查询信息的 GET 请求时发生
`415`	不支持的媒体类型	服务器不接受请求，因为不支持媒体类型
`416`	请求的范围不满意	客户端已请求文件的一部分，但服务器无法提供该部分
`417`	期望失败	服务器无法满足 Expect 请求标头字段的要求

5xx：服务器错误

信息	描述	详细描述
`500`	内部服务器错误	一个通用错误消息，在没有更具体的消息适合时给出
`501`	未实现	服务器要么不识别请求方法，要么无法满足请求
`502`	错误的网关	服务器充当网关或代理，并从上游服务器收到无效响应
`503`	暂停服务	服务器当前不可用（过载或关闭）
`504`	网关超时	服务器充当网关或代理，并未从上游服务器收到及时响应
`505`	不支持 HTTP 版本	服务器不支持请求中使用的 HTTP 协议版本
`511`	需要网络验证	客户端需要进行身份验证才能获得网络访问权限

参考： Http 代码