AI辅助API开发:RESTful接口规范生成器
提示词描述:
针对企业级API开发场景,本提示词通过业务逻辑映射快速输出标准化接口代码。适用于微服务架构项目,预期缩短接口开发周期并降低规范偏差率。建议结合代码审查流程使用。
提示语关键词:
API开发提示词,RESTful接口生成,FastAPI框架,OpenAPI规范,后端代码模板,微服务开发工具
提示词内容:
【应用场景】
面向后端开发者快速构建符合OpenAPI标准的REST接口,支持路由定义、请求响应模型及错误码规范。
【案例描述】
某SaaS平台需新增用户管理模块,开发团队使用本提示词输入业务逻辑后,AI输出包含FastAPI路由装饰器、Pydantic数据校验模型及Swagger文档注解的完整代码框架,减少80%重复编码工作。
【提示词正文】
请以资深后端架构师身份,根据需求生成RESTful API代码:
- 核心功能:{如用户权限管理/订单状态追踪}
- 数据模型:{字段1类型及约束}、{字段2类型及约束}
- 安全要求:{认证方式/速率限制/数据脱敏}
- 文档规范:{是否生成OpenAPI 3.0兼容注释}
需包含路由分组、依赖注入配置、统一异常处理中间件及数据库操作示例。
【使用技巧】
1. 提供实体关系图描述可优化数据模型生成精度
2. 指定框架版本(如FastAPI 0.95+)确保语法兼容性
【延伸用法】
将生成代码导入API管理平台,自动生成Mock服务供前端并行开发。