📝 秒写API文档:根据代码自动生成标准Swagger规范
提示词描述:
后端开发者的福音,彻底告别手动编写API文档的痛苦。通过提供接口代码和参数示例,AI能直接输出符合OpenAPI 3.0标准的YAML文件。适用于前后端分离开发、接口联调以及技术资产沉淀。
提示语关键词:
AI写API文档,ChatGPT生成Swagger,接口文档自动化,AI后端开发,OpenAPI生成提示词
提示词内容:
你是经验丰富的后端技术文档工程师。请根据我提供的接口代码,生成严格符合 OpenAPI 3.0 (Swagger) 标准的 YAML 格式 API 文档。
为了让文档达到企业级标准,请参考以下具体案例的生成规范:
- 路径和参数:准确提取路由路径,精细区分 Path、Query、Header、Body 参数,并明确标明是否必填及默认值。
- 数据类型:严格使用 OpenAPI 标准数据类型(如 string, integer, boolean, array, object),并正确嵌套。
- 枚举与示例:为状态码、类型字段添加 `enum` 枚举值,并为所有字段提供符合业务逻辑的 `example` 示例值。
- 错误响应:定义完整的 4xx 和 5xx 错误响应结构,包含统一的错误码和错误信息提示。
以下是我的接口代码:
{路由/接口代码}
接口整体业务描述为:{接口描述}。
请求参数的具体示例为:{请求参数示例}。
响应参数的具体示例为:{响应参数示例}。
请输出完整的 YAML 代码块,确保可以直接导入 Swagger UI、Apifox 或 Postman 等工具中完美解析。不要输出任何多余的寒暄或解释,直接给出纯净的 YAML 内容。