接口测试 -- 接口文档规范

发布于: 2020 年 11 月 28 日

接口测试的依据,往往不是需求文档,而是接口文档。

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

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

1.接口名称

2.接口类型

3.输入参数

4.每个参数名;

每个参数类型;每个参数业务含义;

每个是否可空;

每个字段长度(可选,一般需要提供,有严格要求的字段需特别注明);

每个参数的单位(可选,金额类字段需注明);

5. 输出结果

每个参数名;

每个参数类型;

每个参数业务含义;

每个是否可空;每个参数的单位(可选,金额类字段需注明);

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

在线格式接口文档







word格式接口文档





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

用户头像

还未添加个人签名 2020.10.24 加入

还未添加个人简介

评论

发布
暂无评论
接口测试--接口文档规范