This documentation is for WSO2 Microgateway 3.0.0. View documentation for the latest release.

All docs This doc
||
Skip to end of metadata
Go to start of metadata

Follow the instructions below to import a single API from WSO2 API Manager and create a Microgateway distribution for it.

Step 1 - Follow the installation prerequisites

Make sure to carry out all the installation prerequisites.

Step 2 - Create a Microgateway project

Let's initialize a API Microgateway project named marketing_project. Navigate to a preferred folder where you want to create the Microgateway project. Thereafter, run the following command.

micro-gw init <project-name>
micro-gw init marketing_project
Project 'marketing_project' is initialized successfully.


Step 3 - Build the Microgateway project

  1. Import the API, which is published in WSO2 API Manager.

    micro-gw import -a <API_name> -v <version> <project_name> 
    micro-gw import -a PizzaShackAPI -v 1.0.0 marketing_project

    WSO2 API Microgateway Toolkit prompts for the following.

    • Username and Password - Enter your user credentials. The username and password should correspond to a valid user in WSO2 API Manager

    • APIM base URL - This is the WSO2 API Manager URL. If you want to use the default value, click enter.

    • Trust store location and password of WSO2 API Microgateway Toolkit - If you want to use the default value, click enter.

    Enter Username: 
    admin
    Enter Password for admin: 
    Enter APIM base URL [https://localhost:9443]: 
    You are using REST version - v0.14 of API Manager. (If you want to change this, go to <MICROGW_HOME>/conf/toolkit-config.toml)
    Enter Trust store location: [lib/platform/bre/security/ballerinaTruststore.p12]
    Enter Trust store password: [ use default? ]
    ID for API 30e623704c5c5479b7c0d9ab78e965df02c1610401e37cbd557e6353e3191c76

    After the API is imported, you can find the auto-generated Swagger definition in the <MGW-project>/gen/<Swagger-file-name>.JSON directory of the project (e.g., /marketing_project/gen/30e623704c5c5479b7c0d9ab78e965df02c1610401e37cbd557e6353e3191c76swagger.json)

    Do not support APIs with synapse mediation extensions

    If the API in the API manager has synapse mediations as custom mediations, then those mediations will not be supported by the microgateway. The logic in custom mediation will have to be reimplement using the microgateway interceptor feature.

  2. Build the WSO2 API Microgateway project (e.g.,marketing_project).
    Navigate to the <MGW_HOME>/bin directory and run the following command.

    micro-gw build <project-name>
    micro-gw build marketing_project
    Compiling source
        src:0.0.0
    
    Running tests
        src:0.0.0
    	No tests found
    
    Generating executable
        ./target//Users/kim/Downloads/TestProj/marketing_project/target/marketing_project.balx

    This creates an executable file (/marketing_project/target/marketing_project.balx) that you can use to expose the API via WSO2 API Microgateway.

Step 4 - Run the Microgateway

Start WSO2 API Microgateway as follows:

Format - Linux/Mac OS
gateway <path-to-MGW-executable-file>
Format - Windows OS
.\gateway.bat <path-to-MGW-executable-file>
Example - Linux/Mac OS
gateway /Users/kim/Downloads/TestProj/marketing_project/target/marketing_project.balx

WSO2 API Microgateway starts for the API. 

ballerina: HTTP access log enabled
[ballerina/http] started HTTPS/WSS endpoint 0.0.0.0:9096
[ballerina/http] started HTTPS/WSS endpoint 0.0.0.0:9095
[ballerina/http] started HTTP/WS endpoint 0.0.0.0:9090
2019-05-30 18:09:32,540 INFO  [wso2/gateway] - HTTPS listener is active on port 9095 
2019-05-30 18:09:32,541 INFO  [wso2/gateway] - HTTP listener is active on port 9090 
  • No labels