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
Database Schema Designer
Design a production-ready database schema from a plain-language description, including tables, relationships, indexes, and migration SQL.
API Endpoint Designer
Design RESTful API endpoints with proper naming, methods, and documentation
Reasoning Model Debug Prompt (Chain-of-Thought Code Fixer)
Uses chain-of-thought reasoning to systematically diagnose and fix code bugs, explaining each step of the reasoning process before proposing a fix.
AI Model Fine-Tuning Dataset Brief Generator
Generates a structured brief and example training data pairs for fine-tuning an LLM on a specific task, persona, or domain.