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
Edge Case Explorer
Generate comprehensive edge cases and boundary condition tests for any system
System Prompt Engineer
Designs optimized system prompts for AI agents with clear instructions, constraints, and output formatting rules.
Chain-of-Verification Generator
Generate self-verifying prompts that ask the AI to check its own outputs against criteria
Chrome Extension Idea Generator & MVP Spec
Generates validated Chrome extension or browser plugin ideas for a given niche, then creates a full MVP spec with features, monetization strategy, and go-to-market plan.