| name | ensemble-generate-api-docs |
| description | Generate comprehensive OpenAPI/Swagger API documentation from codebase (Codex skill for /ensemble:generate-api-docs) |
| user-invocable | true |
Ensemble Command: /ensemble:generate-api-docs
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.
Workflow
Phase 1: API Discovery
1. Endpoint Scanning
Scan codebase for API endpoints
2. Schema Extraction
Extract request/response schemas
Phase 2: Documentation Generation
1. OpenAPI Generation
Generate OpenAPI 3.0 specification
Delegation: @api-documentation-specialist
Discovered endpoints and schemas
2. Example Creation
Create request/response examples
Expected Output
Format: OpenAPI 3.0 Specification
Structure:
- openapi.yaml: Complete OpenAPI specification
- API Documentation: Human-readable API documentation
Usage
/ensemble:generate-api-docs
