Introducing OpenAPI 3.0 Definitions for the Lithic API
We're excited to announce the launch of our OpenAPI 3.0 definitions, which make the Lithic API more accessible and user-friendly for developers. Our goal with this release is to provide a better developer experience and make building products on our platform easier and more efficient.
Using these OpenAPI 3.0 definitions will improve our API reference documentation by providing clearer descriptions of the various endpoints, request/response parameters, and data structures available within the Lithic API. We’ll break out more of the benefits below.
You can find our OpenAPI 3.0 definitions in our GitHub repository.
Benefits of Using OpenAPI 3.0 Definitions
OpenAPI is a widely adopted industry standard for defining and documenting APIs. With OpenAPI 3.0, we will streamline your development experience with several key features:
- Code Generation: OpenAPI 3.0 supports code generation for various programming languages, so you can create SDKs tailored to your preferred language. Using it will reduce the time and effort needed to integrate our API into your applications. In fact, we use this at Lithic to generate our own API libraries.
- Test Cases: OpenAPI 3.0 enables the generation of test cases, ensuring that your integration with our API is robust and reliable. This makes it easier to validate your application's functionality and reduce potential issues.
- Improved API Documentation: The OpenAPI 3.0 format also makes it simpler to create and maintain API documentation. Our fully annotated OpenAPI files will allow you to quickly reference our API's features and capabilities, making it easier to understand our services.
By providing more transparent documentation and facilitating better code generation and testing processes, we hope this creates a more accessible environment for you to build and maintain your applications.