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
Microservice Architecture Designer
Designs a complete microservices architecture for a given application, including service boundaries, communication patterns, data ownership, and deployment topology.
Flutter Mobile App Code Generator
Generate production-ready Flutter code for mobile app screens and features — with proper widget structure, state management, and platform conventions for iOS and Android.
AI Agent System Behavior Tester
Generates a comprehensive test suite of adversarial, edge-case, and functional prompts to stress-test any AI agent or chatbot for reliability, safety, and performance.
Security Threat Model Generator
Generates a structured security threat model for an application or system using the STRIDE framework, identifying attack surfaces, threats, and mitigations.