Harbour
An invented freight API, written for this documentation site.
A worked example, and nothing more: no host behind this replies, save the one operation that says it does.
Harbour moves consignments through berths. The nouns are made up; the shapes are the point — this document exists so the reference pages have every construct of OpenAPI 3.1 to render, including the ones that are easy to leave out.
- 3.2.0
- API version
- 9
- Operations
- 5
- Groups
- 2
- Servers
Endpoints
- Consignments5Everything that is a consignment — a load of freight, with a reference on it and a berth to end up at.
- Vessels1The ships consignments travel on, and what they are carrying.
- Batches1Operations that act on many consignments at once.
- Demo1The one part of this document that is real: an endpoint this very site answers, so the try-it client on the landing page sends a request and gets something back rather than failing against a host that does not exist.
- Webhooks1
Servers
https://api.example.org/{stage}The invented production host.
- stage
- v3
- v1 · v2 · v3
http://localhost:8080A local process, for trying things out.
Authentication
apiKeyapiKey · X-Api-Key · HeaderA key from the account page.
bearerhttp · bearerA token obtained from the authorisation server.
oauthoauth2For applications acting on someone else's behalf.