📝 操作步骤
- 1准备代码库和接口代码
- 2告诉 AI 项目技术栈和框架
- 3AI 扫描路由和接口定义
- 4AI 提取参数、响应和数据模型
- 5生成 OpenAPI YAML 规范
- 6用 Spectral 校验规范合法性
- 7生成 Redoc 可视化文档
- 8发布到文档站点或 CI/CD
💡 示例提示词
我有一个 Go Gin 项目，80+ 个接口，几乎没有注释。帮我生成完整的 OpenAPI 3.1 文档。 要求： 1）扫描 routes/ 和 handlers/ 目录识别所有接口 2）推断每个接口的路径、HTTP 方法、参数、响应结构 3）为参数和字段补充中文描述 4）生成完整的 OpenAPI YAML 5）包含请求/响应示例 6）生成 Redoc HTML 页面 项目结构： - routes/api.go（路由注册） - handlers/user.go、handlers/order.go（业务逻辑） - models/（数据模型定义） 如果接口超过 50 个，请分批提取（user、order、payment 模块），我会手动合并 YAML。