REST API design template
An endpoint table — method, path, auth, status codes — plus the conventions every endpoint follows.
Use this templateFree, opens in your browser. No sign-up.
What's on the board
Table columns: Method, Path, Purpose, Auth, Success, Errors.
- Conventions
- Plural nouns, no verbs in paths (except actions like /cancel)
- Version in the path: /v1
- Errors: { code, message, details } with a stable code
- Idempotency-Key header on POST
- ISO 8601 dates, amounts in minor units
How to use this template
- Click Use this template. It opens in the Kelvo app as a new board, saved in your browser.
- Double-click any box to change its text. Replace the examples with your own content.
- Paste a table. Paste comma- or tab-separated text and it becomes a table. Tab moves to the next cell and adds rows as you go.
- Paste code as code. Paste a snippet and it becomes a code block with syntax colouring; Tab indents inside it.
- Link by dragging. Hover a box and drag one of its dots onto another box. The whole box is the target, and links stay attached when you move things.
Good for
- api
- rest
- endpoints
- backend
- engineer
- Designing a schema or an API before writing it
- Explaining a tricky flow in a code review or design doc
- Agreeing on team conventions such as branching and reviews
Related templates
Sequence diagram (request flow)
Numbered steps across Client, API gateway, service, database and a third party — how one checkout request really travels.
ER diagram (database schema)
Entities as tables with columns, types and keys, joined by one-to-many relationships — sketch a schema before the migration.
UML class diagram
Classes with fields and methods, associations with multiplicity, and an interface with two implementations.
State machine
Every state an order can be in and the events that move it — the source of truth for status logic and tests.
Microservices with API gateway
Clients behind an API gateway, services that each own their database, and an event bus for asynchronous work.
Integration patterns compared
Request/response, queues, pub/sub and batch transfer side by side, with coupling, latency and when to use each.