API reference example
On this page
A sample API that shows what @docvia/plugin-openapi generates. docvia has no HTTP API of its
own; every page in this section is built from this spec.
Base URL v1.4.0
https://petstore.example.com/v1 Production
https://sandbox.petstore.example.com/v1 Sandbox
/api/petstore/v1 Live demo on docvia.dev; accepts any token
Pets
Animals listed for adoption.
| Method | Endpoint |
|---|---|
| GET | List pets /pets |
| POST | Create a pet /pets |
| GET | Get a pet /pets/{petId} |
| PATCH | Update a pet /pets/{petId} |
| DELETE | Delete a pet Deprecated /pets/{petId} |
Orders
Adoption orders and their status.
| Method | Endpoint |
|---|---|
| POST | Place an order /orders |
| GET | Get an order /orders/{orderId} |