api-documentation-generator

Topics in the source

• API Documentation Generator
• Overview
• When to Use This Skill
• How It Works
• Step 1: Analyze the API Structure
• Step 2: Generate Endpoint Documentation
• Step 3: Add Usage Guidelines
• Step 4: Document Error Handling

Automatically generate clear, comprehensive API documentation from your codebase. This skill helps you create professional documentation that includes endpoint descriptions, request/response examples, authentication details, error handling, and usage guidelines. Perfect for REST APIs, GraphQL APIs, and WebSocket APIs. Use when you need to document a new API Use when updating existing API documentation Use when your API lacks clear documentation Use when onboarding new developers to your API Use when preparing API documentation for external users Use when creating OpenAPI/Swagger specifications First, I'll examine your API codebase to understand: Available endpoints and routes HTTP methods (GET, POST, PUT, DELETE, etc.) Request parameters and body structure Response formats and status codes Authentication and authorization requirements Error handling patterns For each endpoint, I'll create documentation including: Endpoint Details: HTTP method and URL path Brief description of what it does Authentication requirements Rate limiting information (if applicable) Request Specification: Path parameters Query parameters Request headers Request body schema (with types and validation rules)

This is an excerpt. Refer to the complete source and its current requirements.