关于接口文档:接口测试接口文档规范

接口测试的根据，往往不是需要文档，而是接口文档。

那么，接口文档的准确性便至关重要，本文举荐 apipost 接口文档生成工具生成的接口文档，供大家参考。

接口文档不论以什么模式存在，须要蕴含的内容有：

1. 接口名称
2. 接口类型
3. 输出参数
4. 每个参数名；
每个参数类型；每个参数业务含意；
每个是否可空；
每个字段长度（可选，个别须要提供，有严格要求的字段需特地注明）；
每个参数的单位（可选，金额类字段需注明）；

1. 输入后果

每个参数名；
每个参数类型；
每个参数业务含意；
每个是否可空；每个参数的单位（可选，金额类字段需注明）；
返回状态的取值范畴及其业务含意。

在线格局接口文档

word 格局接口文档

接口测试接口文档生成工具 apipost 下载地址：https://www.apipost.cn