Skip to main content

Generating SDKs with OpenAPI Generator

Introduction​

At KamioKash, we strive to make our APIs as accessible and easy to integrate as possible. To support this goal, we provide the option for developers to generate client SDKs in various programming languages using the OpenAPI Generator. This tool leverages our OpenAPI specifications to generate client libraries, ensuring that you can integrate KamioKash's functionalities seamlessly into your applications, using the language that works best for your project.

Prerequisites​

Before you begin, ensure you have the following:

  • The latest version of Java installed on your machine. OpenAPI Generator requires Java 8 or later.
  • The URL or local path to KamioKash's OpenAPI specification file. This file describes our API and is necessary for generating your SDK.

Installation​

  1. Install OpenAPI Generator: You can install the OpenAPI Generator CLI in several ways, including Homebrew for macOS, Scoop for Windows, or directly downloading the JAR file. For the most current installation instructions, visit the OpenAPI Generator GitHub repository.

    Example for macOS using Homebrew:

    brew install openapi-generator

  2. Verify Installation: To ensure OpenAPI Generator is installed correctly, run the following command in your terminal:

    openapi-generator version

    This command should display the version number of OpenAPI Generator.

Generating Your SDK​

  1. Choose Your Programming Language: Decide which programming language you'd like to generate the SDK for. OpenAPI Generator supports a wide range of languages and frameworks.

  2. Generate the SDK: Use the OpenAPI Generator CLI to generate your SDK. Replace <language> with your chosen language, and <spec-url-or-path> with the URL or local path to the KamioKash OpenAPI specification file.

    openapi-generator generate -i <spec-url-or-path> -g <language> -o /path/to/output/directory

    Example for generating a JavaScript SDK:

    openapi-generator generate -i https://api.kamiokash.com/openapi.json -g javascript -o ./kamiokash-js-sdk

  3. Explore the Generated SDK: Navigate to the output directory you specified in the previous step. You'll find the generated SDK source code, along with documentation on how to use the SDK in your projects.

Next Steps​

  • Integrate the SDK into Your Project: Follow the documentation included with your generated SDK for instructions on integrating it into your project.
  • Contribute Back: If you make enhancements to the generated SDK that could benefit the KamioKash community, consider contributing back to our GitHub repository. Your contributions can help improve the integration experience for all developers.

Need Help?​

If you encounter any issues while generating your SDK or have questions about using the OpenAPI Generator, please reach out to our support team. We're here to help ensure your integration process is as smooth as possible.