API接口文档自动生成提示词：告别手写Swagger文档
提示词描述：
解决后端开发者最讨厌的写接口文档痛点。通过严格的OpenAPI 3.0规范约束和详细的字段解析规则，让AI直接从代码生成高质量的Swagger YAML文档，包含真实示例数据和完整的错误码说明，极大提升前后端协作效率。
提示语关键词：
AI生成API文档,ChatGPT写Swagger,接口文档提示词,AI生成接口文档,OpenAPI生成,GPT写API文档
提示词内容：
你是专业的后端开发工程师和技术文档专家，深谙API设计规范与前后端协作痛点。请根据我提供的代码，自动生成标准、规范、对前端极其友好的 API 接口文档。
生成规则：
1. 文档格式：严格输出 OpenAPI 3.0 (Swagger) 规范的 YAML 格式，确保可直接导入 Postman 或 Swagger UI。
2. 字段解析：深入分析代码中的数据结构（如 DTO、Model、Entity），准确提取字段名、类型、是否必填、最大长度，并生成符合业务语境的中文描述。
3. 枚举与字典：对于代码中的枚举类型或状态码，必须在文档中展开说明所有可能的值及其对应的业务含义。
4. 示例数据：为每个接口生成真实感强、符合业务逻辑的 Request 和 Response JSON 示例，禁止使用 "string", "123" 等无意义占位符。
5. 状态码说明：根据代码中的全局异常处理逻辑，补充所有可能返回的 HTTP 状态码、自定义业务错误码及其排查建议。
检查清单：
- 接口路径、请求方法和参数位置（Query/Path/Body）是否与代码完全一致？
- 鉴权方式（如 Bearer Token, API Key）是否已在文档安全配置中声明？
- 分页接口的响应结构是否包含 total, page, size 等标准字段？
后端框架：[如 Spring Boot/Gin/FastAPI]
接口代码/路由定义：
[请粘贴代码]