若POST风格下，末尾行动词存在无法拆分的情况，该词汇采用小驼峰式命名，且结构为 动词 + 名词 + 副词 / 形容词
// bad
http://127.0.0.1:6666/api/user/detail/get_all
// good
http://127.0.0.1:6666/api/user/detail/getAll
结构为 名词 + 副词 / 形容词
// bad
userId
// good
id_user
// bad
production、development
// good
prod、dev
// bad
xml、url
// good
XML、URL
在工作中，发现比较常用的词汇，录入到词库中。
如：click、username
在项目界面设计阶段之前，将本次项目专有词，录入到词库中。
如：desktop_cloud
格式 URL 若POST风格下，末尾行动词存在无法拆分的情况，该词汇采用小驼峰式命名，且结构为 动词 + 名词 +...
Swagger API �编写规范 参考文档地址 https://blog.mwaysolutions.com/2...
随着API的迅速发展，如何编写出更加规范的API文档说明则显的尤为重要。你是否还通过手写的方式来生成和编写这些文档...
风格 POST 协议 + 域名/IP + 端口号 + /api + /项目名 + /一级资源 + /n级资源 + ...
位置、格式 请求参数 HTTP方法位置格式ContentTypeGETURL字符串无POST请求体JSONappl...
网络状态码（常见） 2XX —— 成功 数值状态200请求正常处理完毕204请求成功处理，没有实体的主体返回206...
随着API的迅速发展，如何编写出更加规范的API文档说明则显的尤为重要。 你是否还通过手写的方式来生成和编写这些文...
API接口文档的编写已不是什么新鲜事，但文档的编写有时还需针对看文档的人，有所侧重。大多数时候我编写API文档都是...
编写JSDoc是为了增强代码的可读性，以及方便导出API文档。它的规范可参考JSDoc 3 @descriptio...
API 文档的编写让很多 API 编写人员感到头疼，自动生成 API 文档就能帮助我们省心省力地完成任务。 所以今...
本文标题：API 文档编写规范（命名篇）
本文链接：https://www.haomeiwen.com/subject/usjkdhtx.html
网友评论