API Docs

Documentation of our public API to be used by our partners

Deployed at https://engineering.unmade.com/api-docs/.

Rendered using Blueprinter

Local Development

Start the dev server:

docker-compose up dev

You can then navigate to http://localhost:3000/ to see a live preview.

Use:

docker-compose up dev-v2

to work on the V2 docs. This page is deployed under /v2.

Deployment

When you've made your changes to the apiary.apib file, just push any changes to the main branch and the pages site will be automatically updated via a GitHub action.