OpenAPI 3

The basics #

You can view and play around with our API here: ohdear.app/swagger

It uses our swagger.json in the background.

What is the OpenAPI standard? #

The OpenAPI specification (you might know it as Swagger) is a format to describe RESTful APIs. An OpenAPI document is essentially a JSON file that describes the structure of an API.

Our entire API is described in this OpenAPI document: https://ohdear.app/swagger.json.

If you open that url in your browser, you'll see a big JSON file. To make such a document more readable it can be processed with Swagger UI, which will parse the JSON for you.

Alternatively you copy https://ohdear.app/swagger.json in the box at Swagger UI to see our entire api.

Was this page helpful to you? Feel free to reach out via support@ohdear.app or on Twitter via @OhDearApp if you have any other questions. We'd love to help!