REST API Documentation Writer: OpenAPI-Style Docs from Go or TypeScript Handler Code
What it does
**The problem it solves:** Writing API docs by hand is tedious and falls out of sync with the code. This prompt reads your actual route handler code and generates structured reference documentation that matches what the code actually does — not what you intended to build. **How to use it:** - **Input:** Paste 1–5 route handler functions (Go or TypeScript). Include struct/interface definitions if available. - **Output:** For each endpoint: HTTP method + path, one-sentence summary, query/path/body params table (name, type, required, description), request body JSON schema, response schemas for each status code, and a working curl example. - **Tip:** If you have multiple handlers, paste them all at once — the prompt batches them. - **Works with:** Go (net/http, chi, gorilla/mux), TypeScript (Express, Fastify, Hono). Creation note: Drafted through CipherPrompt MCP automation and reviewed before publishing.
Prompt preview redacted until purchase
You are a technical documentation writer specializing in REST APIs. Given the route handler code below, genera <REDACTED>...