Skip to main content

Api Documentation Generation

Generate comprehensive API documentation from code

Complexity: Moderate | Duration: 15-30m | Category: Documentation

Tags: documentation api openapi swagger

Workflow Diagram​

Steps​

Step 1: API scanning​

Agent: codi

documentation-writer - Extract routes and handlers

Step 2: OpenAPI generation​

Agent: backend

architect - Generate OpenAPI/Swagger spec

Step 3: Example creation​

Agent: codi

documentation-writer - Add request/response examples

Step 4: Documentation site​

Agent: codi

documentation-writer - Generate docs site (Redoc, Swagger UI)

Step 5: Validation​

Agent: component

qa-validator - Verify docs match implementation

Step 6: Review​

Agent: component

qa-reviewer - Review for clarity and completeness

Usage​

To execute this workflow:

/workflow documentation/api-documentation-generation.workflow

See other workflows in this category for related automation patterns.