接口文档编写步骤与格式

1. 基本步骤

• 梳理需求

• 依据业务写汉字版的接口文档。（可以减少在实际开发过程中的数据库调整）

  • 写接口文档的过程中，会联想到需要上面样的数据。
  • 进而推出数据库设计。

• 数据库设计完毕。

• 正式的接口文档。

• 前端和后端依据接口文档同步开发。

• 开发完毕或者到一定阶段，进行联调测试。

2. 接口文档格式

• 地址

  • 接口地址：url

• 注释

  • 方法描述

• 请求方式

  • GET/POST方式

• 入参

  • 名字/类型/注释/长度等
  • name 字符串 名字 长度不能超过10
  • age 数字 年龄 0-150

• 出参: 注意JSON对象的格式，因为它对应着后台的数据格式，例如

  • 名字/类型/注释

    {"data":"返回成功"}