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
Technical Debt Audit & Refactoring Plan
Analyzes a codebase description or code sample to identify technical debt, prioritize refactoring opportunities, and produce an actionable cleanup plan with effort estimates.
Debug Root Cause Analyzer
Systematically diagnose bugs and errors using structured root cause analysis — get a clear explanation, fix options, and prevention strategy from any error message or unexpected behavior.
Few-Shot Learning Prompt Builder
Create effective few-shot learning prompts with examples that teach AI models new tasks quickly.
API Documentation Generator
Generate comprehensive API documentation from code or specifications