OpenAPI 3 specifications

What is OpenAPI#

The OpenAPI specifications are a broadly adopted industry standard for describing modern APIs.

What can it do for me?#

We are providing our api as an open api 3 specification yaml file. The file contains the precise description of all our API methods and can be used to easily get started with our system from almost any programming language.

For this purpose, various code generators for clients can be used very easily, which are listed here very nicely:

openapi-generator.tech

So take the yaml file, run the codegen and all the methods and classes are getting generated for you, so you can easily use it in your code.