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
Multi-Agent Orchestrator
Design and coordinate multiple AI agents to work together on complex tasks with role assignment and communication protocols.
Python Automation Script Builder
Generate clean, production-ready Python automation scripts with error handling, logging, and documentation — for web scraping, file processing, API integration, and scheduled tasks.
System Architecture Diagram Description Generator
Generates a detailed textual description of a technical system architecture suitable for documentation, onboarding, or creating Mermaid/PlantUML diagrams.
SQL Query Optimizer
Optimize SQL queries for performance and best practices