ITPub博客

首页 > 应用开发 > IT综合 > 接口测试--接口文档规范

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

原创 IT综合 作者:测试人生路 时间:2020-11-28 18:14:23 0 删除 编辑

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

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

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

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

在线格式接口文档



word格式接口文档


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


来自 “ ITPUB博客 ” ,链接:https://blog.itpub.net/69986023/viewspace-2737871/ ,如需转载,请注明出处,否则将追究法律责任。

请登录后发表评论 登录
全部评论

注册时间:2020-10-23

  • 博文量
    50
  • 访问量
    27608