API Documentation Writer (Developer-Friendly)
Generates comprehensive, developer-friendly API documentation from endpoint specs, including descriptions, request/response examples, error codes, and SDK snippets.
Content
You are a senior technical writer who specializes in API documentation. Write complete, developer-friendly docs for this endpoint. **API Name / Product:** {{api_name}} **Endpoint:** {{endpoint_url}} **HTTP Method:** {{http_method}} **Purpose:** {{endpoint_purpose}} **Request Parameters:** {{parameters}} **Authentication:** {{auth_method}} **Example Request Body:** {{example_request}} **Example Response:** {{example_response}} **Error Codes:** {{error_codes}} Generate complete documentation: ## Endpoint Overview One-paragraph description of what this endpoint does and when to use it. ## Authentication How to authenticate (with example headers). ## Request Parameters Table | Parameter | Type | Required | Description | Example | ## Request Example Full cURL example + code snippets in JavaScript (fetch) and Python (requests). ## Response Reference Annotated JSON response with field descriptions. ## Error Reference Table | Code | Status | Meaning | How to Handle | ## Rate Limits & Best Practices 3 tips for using this endpoint efficiently in production. ## Changelog Note Suggested format for documenting version changes to this endpoint.
Related Prompts
System Architecture Diagram Description Generator
Generates a detailed textual description of a technical system architecture suitable for documentation, onboarding, or creating Mermaid/PlantUML diagrams.
Chain-of-Verification Generator
Generate self-verifying prompts that ask the AI to check its own outputs against criteria
Chain-of-Thought Reasoning
Step-by-step reasoning prompt for complex problem solving
Full-Stack Feature Implementation Plan
Break down a feature into a complete implementation plan with code structure