Skip to main content

Generating an SDK

Once you have defined your API or imported an existing API specification file, you can generate feature-rich SDKs in multiple languages. These SDKs also contain comprehensive readmes.

  1. On the APIMatic Dashboard, click the Generate button for the API you want to generate SDK for.

    Generate SDK APIMatic

  2. If your API has multiple versions, you're prompted to select the API Version you want to generate SDKs for. Click on Proceed. If you have a single version of the API, you will not be prompted.

    API Version APIMatic

  3. Before generating the code, APIMatic performs validation of your API definition file. The validation involves checks to ensure that the API definition is structurally correct and contains complete information to ensure comprehensiveness of the code. There are 3 levels of validation messages that you may encounter:

    • Errors: Any syntax/semantic issues found in the API definition; for example, if a GET method contains a request body. Code generation cannot proceed in case of an error. You will be required to fix the issues listed for your definition if that happens.
    • Warnings: Any unexpected behaviour that may affect the output; for example, if the parameter example provided is invalid. Warnings will not halt code generation, but it is recommended that you fix these issues so your API definition results in the best possible experience.
    • Messages: Recommendations or suggestions that can help enhance your API definition and its completeness. For example, messages can point out that an endpoint description or a parameter example is missing. Messages will not halt code generation.

    Once the validation errors are resolved (if any), click Proceed to move to the next step.

    API Validation APIMatic

  4. Upon successful validation, you will have the option to obtain the SDK in three possible ways:

    • Download the SDK as a Zip file
    • Deploy SDK on GitHub
    • Publish SDK as a package

    For this walkthrough, we will download the SDK as a ZIP file. Click on Download as Zip.

    Download SDK APIMatic

  5. Next, select the Language Platform for your SDK generation:

    APIMatic SDK Platform

  6. Select the required Template for that particular language/platform.

    Platform Template

  7. Once the SDK is generated successfully, you can either choose to click on Generate for another language or download the SDK by clicking on Download as Zip. By default, it is downloaded to your default download location and the zip file is named as <API-NAME>-<SDK-PLATFORM>.

    SDK Success

  8. Unzip this file and get started using your API!

Let’s now try to generate and preview a portal for your API.