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
Agentic Code Architect
Design autonomous AI agent systems for complex tasks
API Documentation Generator
Generate comprehensive API documentation from code or specifications
RAG System Optimization Auditor
Audit and optimize your Retrieval-Augmented Generation pipeline for better accuracy
Code Migration Plan Generator
Creates a comprehensive migration plan for moving from legacy codebases to modern frameworks, including risk assessment and rollback strategies.