美文网首页后端开发
API 文档编写规范(URL篇)

API 文档编写规范(URL篇)

作者: 简栋梁 | 来源:发表于2020-03-08 14:07 被阅读0次

风格

POST

协议 + 域名/IP + 端口号 + /api + /项目名 + /一级资源 + /n级资源 + 动作
如:http://127.0.0.1:6666/api/user/detail/get

RESTful

协议 + 域名/IP + 端口号 + /api + /项目名 + /一级资源 + /n级资源
如:GET http://127.0.0.1:6666/api/user/detail


URL参数

统一使用 & 连接键值对的方式
如:http://127.0.0.1:6666/api/user/get?name_user=Tony&sex_user=1

方法 描述
HEAD 可以对任何资源发出请求,以获取HTTP头信息
GET 查找资源
POST 创建资源
PATCH 替换资源的部分信息
PUT 替换资源的全部信息,要求请求信息是完整的。若某字段不传递,则赋予默认值
DELETE 删除资源

注意点

版本号不应写在URL中

不同版本,可以理解成同一种资源的不同表现形式,所以应该采用同一个URL。版本号可以在HTTP请求头信息的 Accept 字段中进行区分

Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0

RESTful URL 只出现名词

如果某些动作是HTTP动词表示不了的,你就应该把动作做成一种资源。比如网上汇款,从账户1向账户2汇款500元,错误的URI是:
POST /accounts/1/transfer/500/to/2

正确的写法是把动词transfer改成名词transaction,资源不能是动词,但是可以是一种服务:
POST /transaction

相关文章

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

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

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

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

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

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

  • 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 文档编写规范(URL篇)

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