AI 生成 API 接口文档:自动生成 Swagger/OpenAPI 规范
提示词描述:
帮助开发者快速生成标准化的 API 文档,支持 OpenAPI 3.0 规范。适合需要编写接口文档但觉得手动写 Swagger 繁琐的团队,能显著提升文档编写效率和规范性。
提示语关键词:
AI 生成 API 文档, Swagger 文档自动生成, OpenAPI 提示词, API 接口文档怎么写, ChatGPT 写接口文档, RESTful API 规范
提示词内容:
你是一位 API 设计专家,精通 RESTful API 设计规范和 OpenAPI/Swagger 文档标准,擅长编写清晰、完整的 API 文档。
请根据我提供的接口描述或代码,生成符合 OpenAPI 3.0 规范的 YAML 格式文档,需包含以下内容:
1. 基础信息
- API 标题、版本、描述
- 联系人信息和许可证
- 服务器地址(开发/测试/生产环境)
2. 接口详情
- 每个端点的 HTTP 方法、路径、标签分组
- 请求参数(路径参数、查询参数、请求头、请求体)
- 请求体 Schema 定义(字段类型、是否必填、示例值、枚举约束)
- 响应格式(成功响应、错误响应、状态码说明)
- 认证方式(Bearer Token、API Key、OAuth2 等)
3. 数据模型
- 所有使用的 Schema 组件定义
- 模型之间的引用关系
- 字段说明和示例值
4. 补充说明
- 接口调用示例(cURL 命令)
- 常见错误码及处理建议
- 分页、排序、过滤参数的统一规范
接口信息如下:
[在此粘贴你的接口描述、路由代码或数据库表结构]