name: openapi-generator description: 通过代码或遗留API生成OpenAPI规范，支持模式推断和文档生成 allowed-tools: [“Bash”, “Read”, “Write”, “Grep”, “Glob”, “Edit”]
OpenAPI生成器技能
从代码注释、遗留API或运行时分析生成OpenAPI规范，支持模式推断和文档生成。
目的
为以下场景提供API文档支持：
- 从代码生成规范
- 模式推断
- 示例生成
- 验证规则提取
- 文档生成
能力
1. 从代码注释生成规范
- 解析JSDoc/Swagger注释
- 从装饰器提取
- 处理代码注释
- 支持多语言
2. 模式推断
- 从TypeScript类型推断
- 从运行时样本提取
- 基于数据库模型构建
- 从现有负载派生
3. 示例生成
- 生成真实示例
- 创建边界案例样本
- 生成验证示例
- 构建测试夹具
4. 验证规则提取
- 提取验证约束
- 记录必填字段
- 映射格式规则
- 导出枚举值
5. 版本控制支持
- 跟踪API版本
- 生成版本间差异
- 记录破坏性变更
- 支持多版本
6. 文档生成
- 生成Swagger UI
- 创建ReDoc页面
- 导出到Postman
- 构建开发者门户
工具集成
| 工具 | 语言 | 集成方式 |
|---|---|---|
| Swagger Codegen | 多语言 | CLI |
| OpenAPI Generator | 多语言 | CLI |
| springdoc | Java/Spring | 库 |
| NSwag | .NET | CLI |
| tsoa | TypeScript | CLI |
| FastAPI | Python | 自动 |
输出模式
{
"generationId": "string",
"timestamp": "ISO8601",
"specification": {
"openapi": "string",
"info": {},
"paths": {},
"components": {}
},
"artifacts": {
"specFile": "string",
"docsUrl": "string",
"postmanCollection": "string"
},
"coverage": {
"endpoints": "number",
"documented": "number",
"schemasGenerated": "number"
}
}
与迁移流程集成
- api-modernization: 规范生成
- documentation-migration: API文档
相关技能
api-inventory-scanner: 端点发现api-compatibility-analyzer: 版本比较
相关代理
api-modernization-architect: API设计documentation-migration-agent: 文档生成