news 2026/4/18 1:54:41

在接口测试中怎么处理开发是否提供接口文档的总结

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
在接口测试中怎么处理开发是否提供接口文档的总结

最近做了好几个项目的接口自动化,接口测试很重要的参考依据就是接口文档,在自动化实施过程中碰到的接口文档也是千差万别,有的项目没有接口文档,有的项目有接口文档,有接口文档的项目,有的很完善,有的不完善,有的没有和项目迭代保持最新,一直也没有对文档这一块做一个总结,导致工作中很容易发生漏测的情况。

我们为什么要提这个接口文档呢,首先从开发角度,有了接口文档,各个模块之间的开发才能更清楚的知道对方的接口是如何定义和调用的,并且新入职或新接手的开发能快速的上手这个接口,具有指导意义。

其次从测试角度,有了接口文档,测试才知道如何去调用,如何去传参,如何设计用例来验证结果的正确性,不然靠口口相传,一方面沟通的成本会很大,很浪费时间,另一方面不能保证在口头交流过程中漏掉一些东西,导致最终质量上出现缺陷,可见接口文档是多么的重要。

因为公司岗位的特殊性,我们项目目前针对接口文档是这样做的:

用的软件导出图片额度没了,先截图了,不清晰,大概看吧,从上面的图中可以看出,接口文档的提供具有一定的主观性,有些随意,不规范,也没有一定的约束,所以要想保证接口文档的有效性和规范性,首先应该从流程规范上面去约束,虽然google测试之道不推荐强流程和教条式的测试,但是国内目前的环境和大多技术人员的意识还没有达到像google那样的境界,没有流程规范,就不会自觉的去执行,久而久之,便会不了了之。

那么怎么从流程规范上面去约束呢,我目前想到的一个是评审阶段,一个是提测阶段,一个是总结报告阶段,一个是上线阶段,顺序是:

  • 评审阶段

在设计评审和代码评审的时候,就确认接口文档是否可用,是否完善,如果不完善,需要在评审结果中指明,补充完善接口文档。

  • 提测阶段

接口测试人员检查在提测文档中是否包含了接口文档,并检查文档的可读性以及有效性,如果没有接口文档或者可读性极差,则打回提测,待补充完善后重新提测。

  • 总结报告阶段

测试结束后,对本次测试过程中,接口文档的规范性做一个报告,如果接口文档在提测之前没有规范,则在报告中体现出来,并@各方引起重视

  • 上线阶段

这个阶段是产品的最终阶段,不建议立马作为一个流程环节,建议是先做好前面三个阶段的工作后,磨合期已过,各个项目已经适应了前三个阶段,并可以按时提供规范的接口文档后,该阶段再拿出来作为一个审核流程环节,就是如果上线申请中没有接口文档,则不予上线。

最后的阶段是我们的目标,所以我们在推广流程的前期,就要把目标给说出来,说明下最终目标的严重性,并且流程的推广一定要是职位级别从上往下传达。

感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!有需要的小伙伴可以点击下方小卡片领取

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/18 3:51:41

打造高效API客户端代码:自动化生成工具深度解析

打造高效API客户端代码:自动化生成工具深度解析 【免费下载链接】yapi YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台 项目地址: https://gitcode.com/gh_mirrors/ya/yapi 开发者的API调用困境 在现代前端开发中,手动编写AP…

作者头像 李华
网站建设 2026/4/18 3:52:39

抢先速览 | 2026年2月国际学术会议黄金档期全表,一键收藏全学科EI/Scopus日程!IEEE/ACM/SPIE权威出版+7天速录+征稿主题广泛+科研人必备+稳定检索+高录用率+双一流高校主办

2026年2月将在中国及海外多个城市举办20余场国际学术会议,聚焦前沿科技领域。会议涵盖智能感知与控制、人文地理、城乡规划、无人驾驶、智能传感技术、决策智能、社会科学、人文艺术、能源科学、电力工程、材料科学、网络安全、软件工程、环境资源、能源工程、计算机…

作者头像 李华
网站建设 2026/4/18 3:52:31

HTML转DOCX终极指南:10分钟掌握专业文档转换

HTML转DOCX终极指南:10分钟掌握专业文档转换 【免费下载链接】html-to-docx HTML to DOCX converter 项目地址: https://gitcode.com/gh_mirrors/ht/html-to-docx 还在为HTML内容无法直接保存为Word文档而烦恼吗?html-to-docx正是你需要的解决方案…

作者头像 李华
网站建设 2026/4/17 18:59:06

Unity UI粒子特效解决方案:如何彻底解决传统方案的性能瓶颈

Unity UI粒子特效解决方案:如何彻底解决传统方案的性能瓶颈 【免费下载链接】ParticleEffectForUGUI Render particle effect in UnityUI(uGUI). Maskable, sortable, and no extra Camera/RenderTexture/Canvas. 项目地址: https://gitcode.com/gh_mirrors/pa/Pa…

作者头像 李华
网站建设 2026/4/17 8:00:36

DBeaver数据库驱动终极整合方案:一站式解决所有连接难题

DBeaver数据库驱动终极整合方案:一站式解决所有连接难题 【免费下载链接】dbeaver-driver-all dbeaver所有jdbc驱动都在这,dbeaver all jdbc drivers ,come and download with me , one package come with all jdbc drivers. 项目地址: https://gitcod…

作者头像 李华
网站建设 2026/4/16 17:46:26

【限时关注】Dify + Next.js 安全危机(仅剩3天修复窗口期)

第一章:Dify Next.js 安全更新 Next.js 作为现代 Web 应用开发的核心框架之一,在 Dify 项目中承担着前端渲染与路由管理的关键职责。随着应用规模扩大,安全漏洞风险也随之上升,近期针对 Dify 中使用的 Next.js 版本进行了一系列关…

作者头像 李华