美文网首页
API 文档编写规范(状态码篇)

API 文档编写规范(状态码篇)

作者: 简栋梁 | 来源:发表于2020-03-08 14:07 被阅读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 具体失败原因

相关文章

  • API 文档编写规范(状态码篇)

    网络状态码(常见) 2XX —— 成功 数值状态200请求正常处理完毕204请求成功处理,没有实体的主体返回206...

  • API 文档编写规范(URL篇)

    风格 POST 协议 + 域名/IP + 端口号 + /api + /项目名 + /一级资源 + /n级资源 + ...

  • API 文档编写规范(参数篇)

    位置、格式 请求参数 HTTP方法位置格式ContentTypeGETURL字符串无POST请求体JSONappl...

  • API 书写规范

    Swagger API �编写规范 参考文档地址 https://blog.mwaysolutions.com/2...

  • PHP_DOC 实时生成 API 文档

    随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。你是否还通过手写的方式来生成和编写这些文档...

  • API 文档编写规范(命名篇)

    格式 URL 若POST风格下,末尾行动词存在无法拆分的情况,该词汇采用小驼峰式命名,且结构为 动词 + 名词 +...

  • PHP_DOC 实时生成 API 文档

    随着API的迅速发展,如何编写出更加规范的API文档说明则显的尤为重要。 你是否还通过手写的方式来生成和编写这些文...

  • 接口文档编写示例

    API接口文档的编写已不是什么新鲜事,但文档的编写有时还需针对看文档的人,有所侧重。大多数时候我编写API文档都是...

  • JSDoc

    编写JSDoc是为了增强代码的可读性,以及方便导出API文档。它的规范可参考JSDoc 3 @descriptio...

  • 如何使用 Eolink 实现 API 文档自动生成

    API 文档的编写让很多 API 编写人员感到头疼,自动生成 API 文档就能帮助我们省心省力地完成任务。 所以今...

网友评论

      本文标题:API 文档编写规范(状态码篇)

      本文链接:https://www.haomeiwen.com/subject/nnocdhtx.html