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
CI/CD Pipeline Optimizer
Optimize continuous integration and deployment pipelines
Excel VBA Automation Script
Generate VBA macros to automate Excel tasks
Bug Report Generator
Generate detailed bug reports for developers
AI Agent Architecture Planner
Design a multi-agent AI system architecture for any use case