news 2026/6/26 0:33:00

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

作者头像

张小明

前端开发工程师

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

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

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

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

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

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

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

  • 评审阶段

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

  • 提测阶段

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

  • 总结报告阶段

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

  • 上线阶段

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

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

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

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

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

Steam成就管理神器:SAM工具全方位使用手册

Steam成就管理神器:SAM工具全方位使用手册 【免费下载链接】SteamAchievementManager Steam Achievement Manager 项目地址: https://gitcode.com/gh_mirrors/ste/SteamAchievementManager 🎮 Steam Achievement Manager(简称SAM&…

作者头像 李华
网站建设 2026/6/19 9:13:53

群晖NAS第三方硬盘兼容性深度解锁指南:从问题诊断到性能优化

群晖NAS第三方硬盘兼容性深度解锁指南:从问题诊断到性能优化 【免费下载链接】Synology_HDD_db 项目地址: https://gitcode.com/GitHub_Trending/sy/Synology_HDD_db 群晖NAS硬盘兼容性限制是许多技术用户面临的痛点问题,当您精心挑选的高性价比…

作者头像 李华
网站建设 2026/6/13 16:12:00

5步诊断修复法:拯救戴森电池32次红灯故障的完整指南

5步诊断修复法:拯救戴森电池32次红灯故障的完整指南 【免费下载链接】FU-Dyson-BMS (Unofficial) Firmware Upgrade for Dyson V6/V7 Vacuum Battery Management System 项目地址: https://gitcode.com/gh_mirrors/fu/FU-Dyson-BMS 你是否遇到过戴森吸尘器突…

作者头像 李华
网站建设 2026/6/24 23:28:00

Vue3移动端开发终极指南:10分钟快速上手H5项目模板

在移动互联网时代,开发一个适配多端、体验优秀的移动应用是每个前端开发者的必备技能。然而从零开始搭建项目架构往往需要配置Vue3、Vite、TypeScript、Tailwindcss等众多工具,耗费大量时间和精力。今天介绍的Vue3 H5模板正是为解决这一痛点而生&#xf…

作者头像 李华
网站建设 2026/6/20 11:54:17

揭秘Dify容器化测试难题:如何精准配置环境实现99%用例通过率

第一章:Dify容器化测试的挑战与意义在现代软件交付流程中,将 Dify 这类 AI 应用平台进行容器化部署已成为提升可移植性与环境一致性的关键实践。然而,在实现容器化测试的过程中,团队面临诸多挑战,包括依赖隔离、服务间…

作者头像 李华
网站建设 2026/6/21 7:28:52

从卡顿到流畅:我的Windows系统优化之旅

从卡顿到流畅:我的Windows系统优化之旅 【免费下载链接】Winhance-zh_CN A Chinese version of Winhance. PowerShell GUI application designed to optimize and customize your Windows experience. 项目地址: https://gitcode.com/gh_mirrors/wi/Winhance-zh_C…

作者头像 李华