API Documentation Generator
Generate comprehensive API documentation from code or specifications
Content
Generate comprehensive API documentation for the following: API name: {{api_name}} Base URL: {{base_url}} Endpoints or code: ``` {{endpoints}} ``` For each endpoint, document: 1. **Method & Path** (GET, POST, etc.) 2. **Description** - What it does in plain English 3. **Authentication** - Required auth method 4. **Request Parameters** - Path, query, body params with types and required/optional 5. **Request Example** - curl command 6. **Response** - Success response with example JSON 7. **Error Responses** - Common error codes and meanings 8. **Rate Limits** - If applicable Use OpenAPI-style formatting. Include a getting started section.
Related Prompts
Full-Stack Feature Implementation Plan
Break down a feature into a complete implementation plan with code structure
Test Prompt
Test description
AI Code Reviewer
Get comprehensive code review with AI-powered suggestions for improvements
AI Code Reviewer
Get a comprehensive code review with suggestions for improvements, security issues, and best practices