Prompt · Developer Tools

OpenAPI Spec Writer

Writes a complete OpenAPI 3.x spec from handler code or a description.

Have ready: Paste the handler code or describe the endpoints

Fill in · 3 fields

PASTE THE HANDLER/ROUTE CODE OR DESCRIBE EACH ENDPOINT: METHOD, PATH, PURPOSEHOW CLIENTS AUTHENTICATEBASE URL

Your prompt

Write an OpenAPI 3.1 spec for these endpoints.

Source:
[PASTE THE HANDLER/ROUTE CODE OR DESCRIBE EACH ENDPOINT: METHOD, PATH, PURPOSE]
Auth: [HOW CLIENTS AUTHENTICATE]
Base URL: [BASE URL]

Deliver the full YAML spec including:
1. Every path with operationId, parameters, requestBody, and responses (200/201, 400, 401, 404, 422, 500, only the ones that can actually occur).
2. Reusable schemas in components/ for every request/response body, no inline duplication.
3. Realistic examples for requests and responses (not foo/bar).
4. Pagination, filtering, and error envelope conventions applied consistently.
5. A "spec review" note: 3 things in the underlying API design that the act of writing the spec exposed as awkward.

The spec must validate. If you are unsure about a field's type from my description, mark it with x-todo instead of guessing.

Paste it into Muse or any assistant. Blank fields stay as [brackets].

More like this