OpenAPI Description

Understory uses OpenAPI to document and describe our API. This standardised format is machine-readable and can be used in several development workflows.

• Generate API clients in your language and framework of choice
• Mock the API with a generated server based on the spec for integration tests
• Import into an API client to test out the API, e.g. Postman

Using the OpenAPI document

You can explore the OpenAPI document in the API Reference page. It is always up to date with the latest version.

You can also download the specifications in your preferred format below.

• openapi.yaml
• openapi.json

See also

• API Reference