错误码标准的定义
通过约定俗称的一串字母或数字的组合，定义相应的错误状态。以达到开发人员能快速发现并排错的目的。
错误码的标准定义的意义
1、目的
错误码的目的是用来做沟通的：系统与系统间的沟通，人与人间的沟通，人与系统间的沟通。
所以错误码的设计一般要符合开发人员常用习惯。简单、易记、是大家熟悉的错误码样式，并且透出的错误码数量是非常有限的。
2、构成
错误码是人为定义的，就像产品有产品型号编码一样。说出指定编码就能找到对应产品。错误码也一样，错误码其实就程序错误的产品编码。
错误的构成
在设计错误码之前，则先要了解错误的构成。这样才能系统且科学的进行有意义的错误设计。
错误产生来源一般为 A、B、C 三类。
A 表示错误来源于用户，比如参数错误，用户安装版本过低，用户支付超时等问题；
B 表示错误来源于当前系统，往往是业务逻辑出错，或程序健壮性差等问题；
C 表示错误来源于第三方服务，比如 CDN 服务出错，消息投递超时等问题
这里说的是API 的错误码，所以我们主要参考的是http 请求的错误码设计。
http 错误码参考表
1xx（临时响应）
表示临时响应并需要请求者继续执行操作的状态代码。
| 代码 | 说明 |
|---|---|
| 100 | （继续） 请求者应当继续提出请求。 服务器返回此代码表示已收到请求的第一部分，正在等待其余部分。 |
| 101 | （切换协议） 请求者已要求服务器切换协议，服务器已确认并准备切换。 |
2xx （成功）
表示成功处理了请求的状态代码。
| 代码 | 说明 |
|---|---|
| 200 | （成功） 服务器已成功处理了请求。 通常，这表示服务器提供了请求的网页。 |
| 201 | （已创建） 请求成功并且服务器创建了新的资源。 |
| 202 | （已接受） 服务器已接受请求，但尚未处理。 |
| 203 | （非授权信息） 服务器已成功处理了请求，但返回的信息可能来自另一来源。 |
| 204 | （无内容） 服务器成功处理了请求，但没有返回任何内容。 |
| 205 | （重置内容） 服务器成功处理了请求，但没有返回任何内容。 |
| 206 | （部分内容） 服务器成功处理了部分 GET 请求。 |
3xx （重定向）
表示要完成请求，需要进一步操作。 通常，这些状态代码用来重定向。
| 代码 | 说明 |
|---|---|
| 300 | （多种选择） 针对请求，服务器可执行多种操作。 服务器可根据请求者 (user agent) 选择一项操作，或提供操作列表供请求者选择。 |
| 301 | （永久移动） 请求的网页已永久移动到新位置。 服务器返回此响应（对 GET 或 HEAD 请求的响应）时，会自动将请求者转到新位置。 |
| 302 | （临时移动） 服务器目前从不同位置的网页响应请求，但请求者应继续使用原有位置来进行以后的请求。 |
| 303 | （查看其他位置） 请求者应当对不同的位置使用单独的 GET 请求来检索响应时，服务器返回此代码。 |
| 304 | （未修改） 自从上次请求后，请求的网页未修改过。 服务器返回此响应时，不会返回网页内容。 |
| 305 | （使用代理） 请求者只能使用代理访问请求的网页。 如果服务器返回此响应，还表示请求者应使用代理。 |
| 307 | （临时重定向） 服务器目前从不同位置的网页响应请求，但请求者应继续使用原有位置来进行以后的请求。 |
4xx（请求错误）
这些状态代码表示请求可能出错，妨碍了服务器的处理。
| 代码 | 说明 |
|---|---|
| 400 | （错误请求） 服务器不理解请求的语法。 |
| 401 | （未授权） 请求要求身份验证。 对于需要登录的网页，服务器可能返回此响应。 |
| 403 | （禁止） 服务器拒绝请求。 |
| 404 | （未找到） 服务器找不到请求的网页。 |
| 405 | （方法禁用） 禁用请求中指定的方法。 |
| 406 | （不接受） 无法使用请求的内容特性响应请求的网页。 |
| 407 | （需要代理授权） 此状态代码与 401（未授权）类似，但指定请求者应当授权使用代理。 |
| 408 | （请求超时） 服务器等候请求时发生超时。 |
| 409 | （冲突） 服务器在完成请求时发生冲突。 服务器必须在响应中包含有关冲突的信息。 |
| 410 | （已删除） 如果请求的资源已永久删除，服务器就会返回此响应。 |
| 411 | （需要有效长度） 服务器不接受不含有效内容长度标头字段的请求。 |
| 412 | （未满足前提条件） 服务器未满足请求者在请求中设置的其中一个前提条件。 |
| 413 | （请求实体过大） 服务器无法处理请求，因为请求实体过大，超出服务器的处理能力。 |
| 414 | （请求的 URI 过长） 请求的 URI（通常为网址）过长，服务器无法处理。 |
| 415 | （不支持的媒体类型） 请求的格式不受请求页面的支持。 |
| 416 | （请求范围不符合要求） 如果页面无法提供请求的范围，则服务器会返回此状态代码。 |
| 417 | （未满足期望值） 服务器未满足"期望"请求标头字段的要求。 |
5xx（服务器错误）
这些状态代码表示服务器在尝试处理请求时发生内部错误。 这些错误可能是服务器本身的错误，而不是请求出错。
| 代码 | 说明 |
|---|---|
| 500 | （服务器内部错误） 服务器遇到错误，无法完成请求。 |
| 501 | （尚未实施） 服务器不具备完成请求的功能。 例如，服务器无法识别请求方法时可能会返回此代码。 |
| 502 | （错误网关） 服务器作为网关或代理，从上游服务器收到无效响应。 |
| 503 | （服务不可用） 服务器目前无法使用（由于超载或停机维护）。 通常，这只是暂时状态。 |
| 504 | （网关超时） 服务器作为网关或代理，但是没有及时从上游服务器收到请求。 |
| 505 | （HTTP 版本不受支持） 服务器不支持请求中所用的 HTTP 协议版本。 |
借鉴大厂的错误码设计参考
谷歌 API 的错误码定义:
image
腾讯 OpenAPI（文智）错误码定义:
image
image
我个人的错误码表，个人使用仅供参考
| 编码 | 说明 |
|---|---|
| 200 | 成功 |
| 400 | 请求错误 |
| 401 | 未授权，请登录 |
| 403 | 拒绝访问 |
| 404 | 请求地址出错，未找到指定资源 |
| 405 | 请求方法不允许 |
| 406 | 请求地址未授权，拒绝访问 |
| 408 | 请求超时 |
| 409 | 并发冲突，尝试创建资源已存在 |
| 500 | 服务器内部错误 |
| 501 | 服务器未实现该API方法。 |
| 502 | 网关错误。 |
| 504 | 请求超时。 |
| 505 | HTTP 版本不支持 |
借鉴文章:
《微博开放平台-API-错误码》 ：https://open.weibo.com/wiki/Help/error
《腾讯开放平台-错误码》：https://wiki.open.qq.com/wiki/%E9%94%99%E8%AF%AF%E7%A0%81
《Google API Design Guide 》https://www.bookstack.cn/read/API-design-guide/API-design-guide-07-%e9%94%99%e8%af%af.md
