Loading page
About this tool
Parses your endpoint list and builds a documentation prompt covering params, auth, error cases and your chosen doc format.
The API Doc Prompt Builder parses a plain endpoint list — one 'METHOD /path' per line, with {curly} or :colon path parameters — validates every method against RFC 9110, and generates a documentation prompt for OpenAPI 3.1 YAML, a Markdown reference or a README quickstart. It is built for backend developers who want AI-drafted docs that cover every parameter, realistic request/response examples, an RFC-correct error table (400, 401, 403, 404, 409, 422, 429, 500) and TODO(verify) markers wherever the model would otherwise have to guess.
Open API Doc Prompt Builder on AltFTool — it loads instantly in your browser.
Paste your code or data sample into the workspace.
Pick the format, conversion, or analysis you need.
Copy the polished result straight back into your project.
The tool extracts path parameters from {id} or :id placeholders and writes them into the prompt, so no documented endpoint can silently drop a parameter.
The prompt seeds each endpoint with the applicable statuses and RFC 9110 reason phrases — including 422 for validation failures and 429 for rate limits — plus a single shared error-body shape.
Field names, constraints and rate limits the model cannot derive from your list must be marked TODO(verify): instead of fabricated, so the draft is safe to hand to a reviewer.
Five things: a one-sentence purpose, every parameter with location, type, required flag and example, a realistic request and success response with the correct status code, the error cases with their status codes, and a note on idempotency and retry behaviour. The generated prompt demands all five for every endpoint in your list.
At minimum the applicable ones from: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict, 422 Unprocessable Content, 429 Too Many Requests and 500 Internal Server Error — reason phrases per RFC 9110 (429 comes from RFC 6585). The tool writes this list into the prompt with a one-line trigger condition for each.
Use OpenAPI 3.1 when tooling matters — client generation, validation, hosted reference UIs — and Markdown when humans read the docs in a repo or wiki. A README quickstart with curl examples suits small public APIs. This tool generates a format-specific prompt for any of the three from the same endpoint list.
Per RFC 9110, GET, HEAD, PUT, DELETE, OPTIONS and TRACE are idempotent — repeating the request has the same effect as sending it once — while POST and PATCH are not guaranteed to be. The generated prompt asks the documentation to state this per endpoint and describe what retrying each non-idempotent call does.