Skip to main content

OpenAPI description

Toucan REST API is fully described in an OpenAPI 3.0 compliant document.

About OpenAPI descriptions​

OpenAPI is a standard specification for describing REST APIs. OpenAPI descriptions allow both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation. Toucan has made its REST API publicly available as an OpenAPI 3.0 compliant document.

Getting the Toucan OpenAPI description​

coming soon

Using the Toucan OpenAPI description​

There are many uses for an OpenAPI description. For example, you could:

  • Generate your own API client
  • Validate and test a Toucan REST API integration
  • Explore and interact with the Toucan REST API using third-arty tools, such as Insomnia or Postman.

For example, Toucan uses the REST OpenAPI description to generate the Toucan REST API reference documentation