<返回更多

怎么写接口文档

2020-03-15    
加入收藏

一些刚开始写接口文档的服务端同学,很容易按着代码的思路去编写接口文档,这让客户端同学或者是服务对接方技术人员经常吐槽,看不懂接口文档。这篇文章提供一个常规接口文档的编写方法,给大家参考。

一、请求参数

  1. 请求方法
  1. URL

url表示了接口的请求路径。路径中可以包含参数,称为地址参数,如/user/{id},其中id作为一个参数。

  1. HTTP Header

HTTP Header用于此次请求的基础信息,在接口文档中以K-V方式展示,其中Content-Type则是一个非常必要的header,它描述的请求体的数据类型。

常用的content-type:

  1. HTTP Body

描述http body,依赖于body中具体的数据类型。如果body中的数据是对象类型。则需要描述对象中字段的名称、类型、长度、不能为空、默认值、说明。以表格的方式来表达最好。

示例:

 

怎么写接口文档

 

 

二、响应参数

  1. 响应 HTTP Body

响应body同请求body一样,需要描述请清除数据的类型。

另外,如果服务会根据不同的http status code 返回不同的数据结构, 也需要针对不同的http status code对内容进行描述。

 

怎么写接口文档

 

 

三、接口说明

说明接口的应用场景,特别的注意点,比如,接口是否幂等、处理是同步方式还是异步方式等。

笔者平时使用的是 http://www.docway.net(以前叫小幺鸡) 这个网站写接口文档,方便保存和共享。

四、示例

上个示例(重点都用红笔圈出来,记牢了):

 

怎么写接口文档
声明:本站部分内容来自互联网,如有版权侵犯或其他问题请与我们联系,我们将立即删除或处理。
▍相关推荐
更多资讯 >>>