Yapily uses the OpenAPI 3.0.1 specification to schematize our docs and generate our supported client libraries. This provides a consistent developer experience across our external interfaces.
The OpenAPI generator is a maven plugin used to generate server and client libraries from a given OAS file.
First requirement to use the OpenAPI generator is to install Java.
The following tutorial provides an extensive step-by-step guide on how to set up and configure your development environment.
Please refer to this document for Java.
Please refer to this document for Node.
Please refer to this document for Python.
The openapi-generator generation styles vary depending on the chosen language:
- We regard the extension of enumerations in the Yapily API to be a non-breaking change, and we may add new values without advance warning. Please note that some OpenAPI generators automatically employ enum validation by default, however we expect clients to disable strict enum validation for responses in your generated libraries. Otherwise, your clients will experience errors when new enum values are added.
For a better view of the implementation process, check out our examples section which presents a strategy for implementing easily with Yapily in your language of choice.