AI 自动生成 Java API 文档：1分钟输出标准 Swagger 规范
提示词描述：
专为Java后端开发者打造的API文档自动化生成工具。通过结构化提示词，将零散的代码逻辑瞬间转化为符合OpenAPI 3.0标准的高质量Swagger文档，彻底解决前后端接口契约对齐的痛点，提升研发交付效率。
提示语关键词：
AI写代码文档,Java API文档生成,Swagger提示词,ChatGPT写技术文档,自动化文档工具,后端开发效率
提示词内容：
【模板说明】
本模板专为后端开发者设计，通过设定严格的上下文与输出约束，将非结构化的 Java 代码逻辑或接口草稿，转化为符合 OpenAPI 3.0 (Swagger) 标准的高质量 API 文档。有效消除人工编写文档的滞后性与格式不一致问题。
【使用场景】
适用于微服务架构下的接口交付、前后端分离开发中的 API 契约定义，以及遗留系统的接口文档重构。特别适合需要快速生成标准化技术文档的进阶研发人员。
【模板正文】
你是一个资深 Java 架构师及技术文档专家。请根据我提供的 {Java接口代码或业务逻辑描述}，生成符合 OpenAPI 3.0 规范的 YAML 格式 API 文档。
要求：
1. 准确提取 {请求方法}、{路由路径}、{入参结构} 及 {出参结构}。
2. 为每个字段补充符合 Swagger 规范的 description，需包含数据类型、业务含义及枚举值说明。
3. 补充 {HTTP状态码} 及对应的异常响应示例。
4. 确保输出内容可直接粘贴至 Swagger Editor 无语法报错。
【填写指南】
1. {Java接口代码或业务逻辑描述}：粘贴 Controller 层代码或详细的业务流转说明。
2. {请求方法}：如 GET/POST/PUT/DELETE。
3. {路由路径}：如 /api/v1/users/{id}。
4. {入参结构}：包含 Query、Path、Body 参数的具体字段及类型。
5. {出参结构}：返回的 DTO 字段定义。
6. {HTTP状态码}：如 200, 400, 401, 500 等异常场景。
【效果示例】
输入：获取用户详情接口，GET /api/v1/users/{id}，入参 id(Long)，出参 UserDTO(name, age, status)。
输出：标准 Swagger YAML，包含 paths, components/schemas，字段描述清晰，包含 404 Not Found 的异常响应定义。