Example API
An example, to show what Vellum makes of an OpenAPI spec. Harbor manages ships and berths for a harbor that does not exist.
The API behind it is real enough to answer: open an operation and press Try it. It keeps nothing, so a ship you register is gone by the next request, and removing one removes nothing.
These pages are generated from one YAML file. See API reference for how to turn them on for your own.
Version 2.4.0
Servers
/harbor/v2
This site
Authentication
bearerAuth
http (bearer)
Any token will do here. Without one the answer is a 401.
Ships
Vessels registered with the harbor.
-
GET
List ships
/ships -
POST
Register a ship
/ships -
GET
Get a ship
/ships/{shipId} -
DELETE
Remove a ship
/ships/{shipId}
Berths
Where ships dock.