REST API Documentation Writer
Generates complete, developer-friendly REST API documentation from endpoint details including request/response examples, error codes, and authentication.
Content
Write complete REST API documentation for the following endpoint: **API Name / Service:** {{api_name}} **Endpoint:** {{http_method}} {{endpoint_path}} **Authentication:** {{auth_type}} **Purpose:** {{endpoint_purpose}} **Request Parameters:** {{request_parameters}} **Example Request Body (if applicable):** {{example_request}} **Success Response:** {{success_response}} **Possible Error Codes:** {{error_codes}} Generate documentation that includes: ## Overview Brief description of what this endpoint does and when to use it. ## Authentication How to authenticate requests with code examples. ## Request - HTTP method and URL - Headers table (required/optional) - Path/query parameters table with type, required flag, and description - Request body schema with field descriptions ## Request Example Full cURL example + one language example (JavaScript fetch) ## Response - Success response schema with field descriptions - Full JSON response example ## Error Codes Table of all error codes with meaning and recommended action ## Code Examples Complete working examples in Python and JavaScript Format using proper Markdown with code blocks.
Related Prompts
System Prompt Engineer
Designs optimized system prompts for AI agents with clear instructions, constraints, and output formatting rules.
Few-Shot Learning Prompt
Teach AI patterns through examples for better outputs
Red Team Security Tester
Act as a red team attacker to identify vulnerabilities in systems, code, or proposals
Prompt Injection Defense Audit
Audits an AI system prompt or application for prompt injection vulnerabilities, jailbreak risks, and data leakage vectors — then generates hardened replacement prompts.