Generate SDKs in the Developer Portal

A Software Development Kit (SDK) is a set of software development tools that allows you to create applications for a specific platform. If an API consumer wants to create an application, they can generate a client-side SDK for a supported language/framework and use it to write a software application to consume the subscribed APIs.

Downloading SDKs from the Developer Portal

Follow the instructions below to generate and download client-side SDKs via the Developer Portal:

  1. Sign in to the WSO2 API Developer Portal.

    (https://<hostname>:<port>/devportal)

  2. Click on the API for which you want to generate a client-side SDK (e.g., PizzaShackAPI).

    API Overview

  3. Click SDKs.

    The default SDKs that you can download appear.

    Default SDKs

  4. Click Download to download the required SDK.

    This downloads the ZIP archive of the SDK.

    Download SDK

Configuring supported languages for SDK generation

By default, Android, Java, JavaScript, and JMeter the SDKs that are available to be downloaded via the Developer Portal in WSO2 API Manager (WSO2 API-M). In addition to the latter mentioned SDKs, WSO2 API Manager also supports SDK generation for the following languages. Scala, C-Sharp (C#), Dart, Flash, Groovy, Node.js (NodeJs), Perl, PHP, Python, Ruby, Swift, Clojure, AsyncScala, CsharpDotNet2.

Changes based on WSO2 Updates

The following changes with regard to the supported languages for SDK generation is available as an update in WSO2 API-M 4.0.0. If you do not already have this update, see the instructions on updating your product.

Supported Language Action Update Level Released Date
Swift 5 Added 65
(4.0.0.65)
Released Date: January 24, 2022
Flash Removed 65
(4.0.0.65)
Released Date: January 24, 2022

Follow the instructions below to configure the languages available for SDK generation:

  1. Open <API-M_HOME>/repository/conf/deployment.toml file.

  2. Add the following configuration to specify the required languages.

    [apim.sdk]
    supported_languages = ["android", "java", "scala", "csharp", "dart", "flash", "groovy", "javascript"]
  3. Restart the server to apply the configuration changes.

Top