Draft an API description from existing routes
Template that turns existing routes and examples into an OpenAPI draft with a list of open points. Paste it into an AI tool of your choice, which then writes the API description draft.
- Topic
- Apps & prototypes
- Type
- Template
- Level
- Intermediate
- Time
- about 15 min
Results depend on the tool, the model and what you enter.
Result preview
Example: written by our editors, not real AI output.
paths: /orders/{id}: get: summary: Get one order responses: "200": { $ref: "#/components/schemas/Order" } "404": { description: Order not found } Open points: - status: "open" here, "pending" in /orders - Error format of /refunds unknown
Fill in
What you type stays in this browser window. We store and send nothing.
- shop backend with orders and products
- internal service for user accounts
- small REST API of a side project
- partner API for customers
- webhook endpoints
- route definitions from the code
- example requests and responses
- an old wiki page
- logs of real calls without personal data
- a mix of these
- documentation for partners
- generating a client
- contract checks in the build
- onboarding new developers
- a first overview
Your prompt
You have edited the prompt. Changes in the fields above no longer overwrite it.
This is an instruction for an AI, not the result itself.
Where this prompt works
These AI tools are a good fit for this prompt:
How to use it
- Fill in the fields or tap a suggestion. Leave out names, addresses and other personal data.
- Copy the finished prompt into an AI tool of your choice.
- Paste examples with made-up values; real tokens and customer data do not belong in the material.
Why does this work?
A description written from the code shows the gaps nobody notices while the code works: undocumented errors, fields with two meanings and routes that break the pattern.
Tips
- Compare the draft with the running API before you publish it; a description that differs from reality is worse than none.