接口文档规范

基本内容

接口文档不管以什么形式存在，需要包含的内容有：

1. 接口名称

2. 接口类型

3. 输入参数

• 每个参数名；

• 每个参数类型；每个参数业务含义；

• 每个是否可空；

• 每个字段长度（可选，一般需要提供，有严格要求的字段需特别注明）；

• 每个参数的单位（可选，金额类字段需注明）；

4. 输出结果

• 每个参数名；

• 每个参数类型；

• 每个参数业务含义；

• 每个是否可空；每个参数的单位（可选，金额类字段需注明）；

• 返回状态的取值范围及其业务含义。

推荐使用swagger生成在线文档，具体可见我博客内使用说明。

静态文档示例