Paste your code or describe your endpoints, and this prompt kit returns a valid OpenAPI 3.x spec in YAML or JSON plus a matching README. It is meant for developers who need API docs without writing them by hand.
What you get
- A complete OpenAPI document in one code block: info, servers, tags, paths and a unique camelCase operationId per operation
- Parameters, request bodies, success responses and realistic errors (400, 401, 404, 422, 500 as applicable)
- Reused schemas via $ref and security schemes matching your auth method
- An example for every request body and success response
- A README with overview, authentication, base URL, a quick-start curl call and an endpoints table
- An "Assumptions" list where your source was ambiguous
Who it's for
Backend developers, API owners and technical writers at an intermediate level. The prompt documents only the endpoints, fields and status codes present in your source, so the spec reflects what your API actually does rather than a guess.
Works with Claude, ChatGPT and other AI chats.