Document an API endpoint

Reference docs a stranger could implement against.

Works with ChatGPT, Claude, Gemini

Use it when: Writing docs nobody has time to write.

Fill in the blanks

Code

Your prompt

Write reference documentation for this endpoint.

Code or spec:
[Code]

Return in markdown:
- Method and path, one-line purpose.
- Auth requirements.
- Parameters table: name, type, required, default, description.
- Example request and example success response.
- Every error code with what triggers it and how to recover.
- One realistic end-to-end usage example.

Make it yours

Improve your own version, or save it with your usual details filled in.

Improve with AI Save to my vault

Get the extension Learn to write your own

More coding prompts

CodingChatGPT, Claude, Gemini
Build and explain a regex
A pattern you can actually read, with test cases.
Fill it in and copy
CodingChatGPT, Claude, Gemini
Debug an error properly
Forces the model to rank causes by likelihood before proposing a fix.
Fill it in and copy
CodingChatGPT, Claude, Gemini
Explain this code line by line
A walkthrough pitched at your level, plus the parts most likely to bite you.
Fill it in and copy
CodingChatGPT, Claude
Refactor without changing behaviour
Small, safe, reviewable steps instead of a rewrite.
Fill it in and copy

Fill in the blanks

Your prompt

Make it yours

More coding prompts

Build and explain a regex

Debug an error properly

Explain this code line by line

Refactor without changing behaviour