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
Legacy Code Migration Assistant
Analyze and plan migration of legacy code to modern tech stack
Self-Consistency Verification Prompt
Generate prompts that verify AI responses for internal consistency across multiple reasoning paths.
Agentic Code Architect
Design autonomous AI agent systems for complex tasks
Code Migration Plan Generator
Creates a comprehensive migration plan for moving from legacy codebases to modern frameworks, including risk assessment and rollback strategies.