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

网友投稿 726 2022-05-29

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

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

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

1.接口名称

2.接口类型

3.输入参数

4.每个参数名;

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

每个是否可空;

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

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

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

5. 输出结果

每个参数名;

每个参数类型;

每个参数业务含义;

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

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

在线格式接口文档

word格式接口文档

接口测试接口文档生成工具apipost-:https://www.apipost.cn

自动化测试

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:文档的基本操作
下一篇:OCR文档识别是办公学习文档处理的不二助手!
相关文章