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

举报
奔四码农 发表于 2020/11/28 18:06:11 2020/11/28
【摘要】 接口测试的依据,往往不是需求文档,而是接口文档。那么,接口文档的准确性便至关重要,本文推荐apipost接口文档生成工具生成的接口文档,供大家参考。接口文档不管以什么形式存在,需要包含的内容有:1.接口名称2.接口类型3.输入参数4.每个参数名;每个参数类型;每个参数业务含义;每个是否可空;每个字段长度(可选,一般需要提供,有严格要求的字段需特别注明);每个参数的单位(可选,金额类字段需注明...

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

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

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

1.接口名称
2.接口类型
3.输入参数
4.每个参数名;
每个参数类型;每个参数业务含义;
每个是否可空;
每个字段长度(可选,一般需要提供,有严格要求的字段需特别注明);
每个参数的单位(可选,金额类字段需注明);
5. 输出结果
每个参数名;
每个参数类型;
每个参数业务含义;
每个是否可空;每个参数的单位(可选,金额类字段需注明);
返回状态的取值范围及其业务含义。

在线格式接口文档



1.png

2.png

word格式接口文档

3.png

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

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。