智能API文档生成器:一键生成OpenAPI规范
提示词描述:
面向后端开发团队和API产品经理,快速生成符合OpenAPI 3.0标准的接口文档。支持从需求描述直接生成可导入Swagger UI的完整文档,大幅提升前后端协作效率。
提示语关键词:
API文档生成,OpenAPI规范,Swagger文档,接口文档,后端开发,技术文档
提示词内容:
请作为技术文档专家,为以下API生成完整的OpenAPI 3.0规范文档:
基本信息:
- 服务名称:{服务名称}
- API版本:{版本号}
- 基础路径:{basePath}
- 认证方式:{认证方式}
端点清单:
{列出所有端点,格式:HTTP方法 路径 - 功能描述}
生成要求:
1. 完整的Schema定义(请求体、响应体、错误码)
2. 参数校验规则(类型、格式、必填项)
3. 示例请求与响应(包含成功和失败场景)
4. 安全配置说明
5. 版本变更日志模板
文档格式:
- 使用YAML格式
- 包含中文描述字段
- 遵循OpenAPI最佳实践
- 提供Postman Collection导入说明
特别要求:
- 为每个端点提供至少2个示例值
- 标注废弃字段和替代方案
- 包含限流和错误处理说明