5个AI提示词模板：让API文档生成效率提升10倍
提示词描述：
覆盖API文档全生命周期的提示词集合，从代码到OpenAPI规范、从错误码体系到SDK生成，提供一站式文档解决方案。帮助开发团队保持文档与代码同步，提升前后端协作效率。
提示语关键词：
AI生成API文档,OpenAPI规范,API文档自动化,AI编程提示词,接口文档生成,Swagger文档
提示词内容：
【使用场景】
为RESTful/GraphQL接口快速生成标准化API文档，解决文档滞后、描述不一致等问题。
【操作步骤】
1. OpenAPI规范生成
```
请根据以下代码生成OpenAPI 3.0规范：
{粘贴Controller代码}
要求：
- 包含完整的Schema定义
- 标注认证方式
- 添加示例请求/响应
```
2. 接口描述优化
```
请优化以下接口描述：
{原始描述}
要求：
- 使用主动语态
- 包含业务上下文
- 标注使用限制（如频率、权限）
```
3. 错误码体系生成
```
为以下服务生成标准化错误码：
{服务名称}
要求：
- 采用HTTP状态码+业务码组合
- 包含错误原因及解决方案
- 支持多语言描述
```
4. 变更日志生成
```
对比以下两个版本的API：
{V1代码} vs {V2代码}
生成变更日志，包含：
- Breaking Changes标注
- 废弃接口迁移指南
- 版本兼容性说明
```
5. SDK代码生成
```
基于以下OpenAPI规范生成SDK：
{OpenAPI JSON}
目标语言：{Java/Python/JS}
要求：
- 包含类型定义
- 生成示例代码
- 添加重试机制
```
【效果示例】
输入：Spring Boot Controller代码
输出：
- 完整的OpenAPI 3.0 JSON
- 带示例的接口文档
- 标准化错误码表
- Java SDK代码
【进阶技巧】
- 集成Swagger UI实时预览
- 使用Postman Collection同步测试
- 通过CI/CD自动更新文档
- 结合GraphQL Schema生成类型定义