api-documentation-generator

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. First, I'll examine your API codebase to understand: For each endpoint, I'll create documentation including: Endpoint Details: Request Specification: Response Specification: Code Examples: I'll include: Clear error documentation including: Where possible, I'll provide: Introduction Authentication Quick Start Endpoints Data Models Error Handling Rate Limiting Changelog SDKs and Tools Symptoms: Examples don't work, parameters are wrong, endpoints return different data Solution: Symptoms: Users don't know how to handle errors, support tickets increase Solution: Symptoms: Users can't get started, frustration increases Solution: Symptoms: Users send invalid requests, validation errors Solution: Generate interactive documentation: Export collection for easy testing: Pro Tip: Keep your API documentation as close to your code as possible. Use tools that generate docs from code comments to ensure they stay in sync! - 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...