③数字清单:5步生成企业级API接口代码
提示词描述:
面向企业级开发的API生成模板,覆盖从接口定义到测试的全流程,自动生成符合REST规范的可运行代码。适合需要标准化接口开发的团队。
提示语关键词:
API代码生成,后端开发提示词,接口文档自动化,RESTful设计,AI编程助手,企业级开发
提示词内容:
【模板说明】
按照企业开发规范,通过分步指令生成包含完整文档、错误处理和安全校验的RESTful API代码。
【使用场景】
• 微服务接口开发
• 第三方API对接
• 接口文档自动生成
• 安全认证模块集成
【模板正文】
你是一位后端架构师,请按以下步骤生成API代码:
Step1 接口定义:
- 路径:{填写:如/api/v1/users}
- 方法:{GET/POST/PUT/DELETE}
- 认证方式:{JWT/OAuth/无}
Step2 数据模型:
- 入参校验:{填写:如邮箱格式/手机号正则}
- 出参结构:{填写:如包含分页信息}
Step3 异常处理:
- 错误码规范:{填写:如HTTP状态码/自定义码}
- 日志记录:{详细/关键错误/无}
Step4 文档生成:
- 接口文档格式:{Swagger/Postman/Markdown}
- 示例数据:{是/否}
Step5 测试用例:
- 单元测试框架:{Jest/PyTest/JUnit}
- 测试覆盖率要求:{填写百分比}
【填写指南】
1. 认证方式需与现有系统兼容
2. 错误码建议采用国际通用标准
3. 测试用例应包含边界条件
【效果示例】
输入:POST /api/v1/orders + JWT认证 + 分页返回
输出:包含Spring Boot控制器代码、Swagger文档、JUnit测试类的完整接口方案