API 文档编写规范（状态码篇）
2020-03-08 本文已影响0人
简栋梁
网络状态码（常见）
2XX —— 成功
| 数值 | 状态 |
|---|---|
| 200 | 请求正常处理完毕 |
| 204 | 请求成功处理，没有实体的主体返回 |
| 206 | GET范围请求已成功处理 |
3XX —— 重定向
| 数值 | 状态 |
|---|---|
| 301 | 永久重定向，资源已永久分配新URI |
| 302 | 临时重定向，资源已临时分配新URI |
| 303 | 临时重定向，期望使用GET定向获取 |
| 304 | 附带条件未满足 |
| 307 | 临时重定向，POST不会变成GET |
4XX —— 客户端错误
| 数值 | 状态 |
|---|---|
| 400 | 请求报文存在语法错误 或 参数错误 |
| 401 | 未认证、认证失败 |
| 403 | 请求资源被拒绝 |
| 404 | 无法找到请求资源 |
5XX —— 服务端错误
| 数值 | 状态 |
|---|---|
| 500 | 服务器故障、web应用故障 |
| 503 | 服务器超负载、停机维护 |
网络状态码大全
https://httpstatuses.com/
数据状态码
一级数据状态码
| 数值 | 状态 |
|---|---|
| 0 | 成功 |
| 1 | 失败 |
| 2 | 成功，但数据为空 |
二级数据状态码
| 数值 | 状态 |
|---|---|
| 1001 | 具体失败原因 |
