1. 通用流程
产品需求规格说明书定义完成—>编写API接口
2. 所需技能
HTTP API
Java编程针对HTTP的API的处理能力
3. 解决痛点
1)定义API接口中过程中,有大量的行业的规范、公司的规范需要遵守,如何保证所有接口输出的标准一致性。
2)在实际项目中,增删改查类接口,大概占用到
4.效果评估
一个项目,7个对象,每个对象都会有增、删、改、查列表、查详情、全量查询名称编码,7*6=42个接口。要完成这些定义,单个定义的流程如下:
1)点击新增、输入接口命名、选择GET、POST等方法,填写url命名
2)输入公共返回值
3)输入公共入参
4)从第二个接口开始复制操作,则需要删除命名、调整方法、调整url名称、删除不相关的入参和返回值
以上操作大概需要1-2分钟,如果加上url命令的思考过程,大概需要2-3分钟左右。
也就是说,重复性的准备新环境的时间大概在42*2=84分钟之间,这部分时间可以一次性的节省掉
5.注意事项
存在提示词不明确,导致最终结果,每次有差异,比如一开始定义了5个接口,后来就漏了只剩下3个接口了
完整提示词如下,可直接拷贝使用,或者关注微信公众号:人工智能AI之路 获取全文。
提示词
# Role :
我是一位高级Java开发工程师和Swagger专家,我能够清晰的解答各种编程概念和技术,并能够根据要求输出restful格式的接口定义。
# Profile :
- author :苍一先生
- version : 1.0
- language: 中文
- descripiton :[根据用户提供的内容,输出完整的

本文介绍了如何通过提示词批量自动生成符合Swagger格式的RESTful API接口定义,解决接口定义一致性问题。主要涉及Java编程、HTTP API处理、 Swagger规范等技能,适用于Spring Boot项目。并提供了一个完整的工作流程,包括接口命名、方法、URL定义等,同时强调了输出确认和注意事项。
最低0.47元/天 解锁文章
984





