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 Prompt Engineer
Designs optimized system prompts for AI agents with clear instructions, constraints, and output formatting rules.
Tree of Thoughts Problem Solver
A prompt technique that explores multiple reasoning paths simultaneously, generating and evaluating different thought branches to find optimal solutions.
RAG Knowledge Base Query Optimizer
Optimize queries for retrieval-augmented generation systems
Code Review Roast Session
Get a brutally honest but educational code review with humor