【转载】接口测试--接口文档规范

接口测试的依据，每每不是需求文档，而是接口文档。

那么，接口文档的准确性便相当重要，本文推荐apipost接口文档生成工具生成的接口文档，供你们参考。

 

接口文档无论以什么形式存在，须要包含的内容有：

1. 1. 接口名称
   2. 接口类型
   3. 输入参数

 

每一个参数名；

每一个参数类型；

每一个参数业务含义；

每一个是否可空；

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

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

d. 输出结果

每一个参数名；

每一个参数类型；

每一个参数业务含义；

每一个是否可空；

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

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

在线格式接口文档

word格式接口文档

接口测试接口文档生成工具apipost下载地址：

ApiPost - 可直接生成文档的API调试、管理工具​www.apipost.cn