All templates
💻 Coding·Works on: claude, chatgpt, cursor
API Documentation Generator
Turn raw code into clean, copy-paste-ready API docs.
#api#documentation
0/2
Fill the template
2 placeholders left.
~166tokens
Live preview· click any pill to jump to its field
Generate API documentation for the following endpoint(s). Code: ``` ``` Output format: Markdown with these sections for EACH endpoint: 1. **Method + path** (one line) 2. **What it does** (one sentence, plain English) 3. **Auth** required (yes/no, type) 4. **Request** — params/body, with example JSON and which fields are required. 5. **Response** — example 200 body, example error responses with status codes. 6. **Edge cases** — anything that returns differently than you'd expect. 7. **Example curl** — copy-paste runnable. If there's behavior you can't infer from the code (rate limits, side effects), list it under "Assumptions to verify".
Inputs0 of 2
›See the lazy version this template replaces
Before — the lazy prompt
document this api
Why it works
- Sectioned output makes it useful as actual docs, not just a paragraph.
- Runnable curl is the single thing API consumers want most.
- Explicit assumptions section makes the doc safe to publish.
Make this one yours
Replace the bracketed placeholders, then paste into the Prompt Fixer to lint your customisation before hitting send.