API Documentation

When to Use

• Building or updating REST/GraphQL API documentation
• Onboarding new developers who need to understand available endpoints
• Preparing API reference docs for external consumers
• Ensuring API docs stay synchronized with implementation
• Creating OpenAPI/Swagger specifications from existing code

Prerequisites

• API source code with route definitions
• Understanding of the API framework (Express, FastAPI, Gin, etc.)
• Knowledge of request/response formats and authentication requirements

Workflow

1. Discover All Endpoints