一键导入
ensemble-generate-api-docs
Generate comprehensive OpenAPI/Swagger API documentation from codebase (Codex skill for /ensemble:generate-api-docs)
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
菜单
Generate comprehensive OpenAPI/Swagger API documentation from codebase (Codex skill for /ensemble:generate-api-docs)
用 Codex 或 Claude 帮你安装 复制这段 Prompt,粘贴到 Codex、Claude 或其他助手里,让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Generate a normalized executable workstream TRD from multiple source TRDs (Codex skill for /ensemble:create-workstream-trd)
Implement TRD with beads project management — persistent bead hierarchy, dependency-aware execution via br/bv, and cross-session resumability (Codex skill for /ensemble:implement-trd-beads)
Approval-gated Beads graph refinement before execution (Codex skill for /ensemble:refine-beads)
Create Foreman-native structured Technical Requirements Document from PRD — omits adversarial review phase, outputs parser-compatible tables (Codex skill for /ensemble:create-trd-foreman)
Create Technical Requirements Document from PRD with architecture design and adversarial review (Codex skill for /ensemble:create-trd)
Create comprehensive Product Requirements Document with structured elicitation and adversarial review (Codex skill for /ensemble:create-prd)
| name | ensemble-generate-api-docs |
| description | Generate comprehensive OpenAPI/Swagger API documentation from codebase (Codex skill for /ensemble:generate-api-docs) |
| user-invocable | true |
This Codex skill mirrors the Ensemble slash command /ensemble:generate-api-docs.
Follow the workflow below, adapt to the current repository, and keep outputs structured.
Generate comprehensive API documentation from codebase analysis, including OpenAPI/Swagger specifications, endpoint descriptions, request/response examples, and error documentation.
1. Endpoint Scanning Scan codebase for API endpoints
2. Schema Extraction Extract request/response schemas
1. OpenAPI Generation Generate OpenAPI 3.0 specification
Delegation: @api-documentation-specialist Discovered endpoints and schemas
2. Example Creation Create request/response examples
Format: OpenAPI 3.0 Specification
Structure:
/ensemble:generate-api-docs