接口文档没有固定的样式,只要把相关的信息显示出来就可以

例如:

  1. 接口名称
  2. 接口说明
  3. 接口地址
  4. 请求参数
  5. 返回参数
  6. 错误码(一般大批量的接口都使用统一的错误码来返回)

下面是本人使用过的接口文档样式

这是腾讯官方的接口文档

相关文章: