有小伙伴想让AI根据接口文档来生成接口脚本,从而辅助接口自动化测试,但是公司没有提供接口文档或者提供的不规范。想自己根据项目代码去生成一份接口文档,但又不知道该包含哪些关键信息,要怎么写才能让AI更好的生成脚本。所以我针对这个需求生成了一个**「读取项目代码生成接口文档的 skill」**,希望能帮助到你们~
该Skill的作用
面向 Java、Go、Python、Node.js 多技术栈后端项目,从源码中扫描 HTTP 接口定义,并根据用户指定范围生成 JSON 或 Markdown 形式的接口文档。
适合哪些人用?
- • 你想用 AI 生成接口自动化脚本,但连一份可信的接口列表都没有。
- • 公司没有统一的接口文档规范,各个服务的文档风格完全不一样。
- • 你手上有代码权限,却没有时间一条条对着接口慢慢抄。
- • 如果有些小伙伴没有代码权限,也可以将这个 skill 包发给开发人员,让他去帮忙生成
案例介绍
为了方便演示,我拿若依这个开源项目作为案例进行讲解:
一方面,它本身就是很多团队熟悉的 Spring Boot + 前后端分离架构;然后业务模块多、接口也足够复杂,适合拿来验证 skill 在真实项目里的表现。
1、我们在对话框:引用 skill,并输入我们要生成接口文档的相关模块(如下图)
至于模块名称叫什么,要怎么去描述,这里建议自己先熟悉一下项目代码的命名
2、接着 AI 自己就会去调用 skills,并扫描项目的后端代码
3、最后会在指定的文件目录下生成markdown 格式的接口文档,里面包含了该模块的相关接口信息(URL、请求体、响应体等)
建议可以自己抽一些接口检查看看是否有错误或者遗漏的地方
当然,如果不是很放心,那么也可以让 ai 根据接口文档去反过来检查生成的接口文档的质量效果如何
4、所以,针对这个校验,我们可以封装多一个检查的skills
使用案例如下:
5、我上面只是让它生成某个模块的接口信息,如果你想让他生成一整个项目的接口信息也是可以的,在 skills.md里面有对应的指令,另外也支持生成 json 格式的,如果你需要,也可以在对话框那里补充说明一下。
以上是这个【读取项目代码生成接口文档的 skills】的实现思路和案例分享。
想系统跟进更多实战?
本篇提到的skills以及更多能应用到测试工作中的skills都更新在学习圈了,这个skills也是我接下来搞AI驱动接口自动化测试系列实践的一小部分,如果你希望持续跟进后续案例以及更多AI赋能测试场景,可以到公众号【Raina测试】了解看看哦