====== Swagger Codegen (WMC >= 3.1) ===== Swagger Codegen can simplify your build process by generating server stubs and client SDKs for any API, defined with the OpenAPI (formerly known as Swagger) specification, so your team can focus better on your API’s implementation and adoption. Interesting link: \\ [[https://swagger.io/tools/swagger-codegen/|Swagger Codegen | API Development Tools | Swagger]] \\ \\ \\ ===== Goal ===== The current page explains how to generate a REST java client in order to use Kerlink GMS API methods to create a customer, a fleet, a gatewway, a cluser and an end-device and get information about them. \\ \\ ===== Requirements ===== Building the API client library requires: - **JDK 1.7+** (JDK 12 is the best choice) - **Maven/Gradle** (version 3.3.9-3 is available in the official Ubuntu 16.04 repository) - **Eclipse Java EE IDE** for Web Developers (Version: 2019-06 (4.12.0) for instance) For Eclipse, you can find it here: [[https://www.eclipse.org/downloads//|Enabling Open Innovation & Collaboration | The Eclipse Foundation]] \\ \\ ===== Download the GMS API JSON file ===== From the WMC 3.1 dashboard, import the GMS API JSON file: \\ {{:wiki3:pushapi.png|}} \\ {{:wiki3:postman_environnement_export_openapi_json.png?800|}} \\ Rename the file ''openapi'' to ''openapi.json'' \\ \\ ===== Download Swagger Codegen CLI tool =====


wget http://central.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.8/swagger-codegen-cli-3.0.8.jar

\\ \\ ===== Generating a client ===== Swagger Codegen allows you to generate a client in a wide variety of languages. You may check if your preferred programming language is available by executing


java -jar swagger-codegen-cli-3.0.8.jar langs

Here is a sample of the results:


tda@KLK724-VirtualBox-64:~/Development/Swagger$ java -jar swagger-codegen-cli-3.0.8.jar langs
15:21:40.233 [main] DEBUG io.swagger.codegen.v3.cli.SwaggerCodegen - there are not options for command 'langs'
15:21:40.236 [main] DEBUG io.swagger.codegen.v3.cli.SwaggerCodegen - there are not options for command 'version'
Available languages: [aspnetcore, csharp, csharp-dotnet2, dynamic-html, html, html2, java, jaxrs-cxf-client, jaxrs-cxf, inflector, jaxrs-cxf-cdi, jaxrs-spec, jaxrs-jersey, jaxrs-di, jaxrs-resteasy-eap, jaxrs-resteasy, spring, nodejs-server, openapi, openapi-yaml, kotlin-client, kotlin-server, php, python, scala, scala-akka-http-server, swift3, swift4, typescript-angular]

\\ \\ ===== Generating client code for Java ===== Here is the command to generate the JAVA client code:


java -jar swagger-codegen-cli-3.0.8.jar generate -i openapi.json -l java -o ./java_api_client/ --additional-properties hideGenerationTimestamp=true

This command has created the **java_api_client** directory:


tda@KLK724-VirtualBox-64:~/Development/Swagger$ ls
generating_client.log  java_api_client  openapi.json  swagger-codegen-cli-3.0.8.jar

tda@KLK724-VirtualBox-64:~/Development/Swagger/java_api_client$ ls
build.gradle  build.sbt  docs  git_push.sh  gradle  gradle.properties  gradlew  gradlew.bat  pom.xml  README.md  settings.gradle  src

You can find the **Client API** under ''./java_api_client/src/main/java/io/swagger/client'':


tda@KLK724-VirtualBox-64:~/Development/Swagger/java_api_client/src/main/java/io/swagger/client$ ls
api               ApiClient.java     ApiResponse.java  Configuration.java           JSON.java  Pair.java                 ProgressResponseBody.java
ApiCallback.java  ApiException.java  auth              GzipRequestInterceptor.java  model      ProgressRequestBody.java  StringUtil.java

The most useful files are //ApiClient.java// and //ApiResponse.java//. ApiClient is used to build an HTTP Request and ApiResponse to decode an HTTP response. **GMS API** can be found in ''./java_api_client/src/main/java/io/swagger/client/api'':


tda@KLK724-VirtualBox-64:~/Development/Swagger/java_api_client/src/main/java/io/swagger/client/api$ ls
ActionsApi.java              ClustersApi.java           DefaultApi.java     FleetsApi.java        LnsEventsApi.java          PasswordApi.java            SelectionsApi.java    WebServicesApi.java
AlgorithmsApi.java           CustomersApi.java          DocApi.java         GatewaysApi.java      LoginApi.java              PingApi.java                SpectrumsApi.java     WorkflowApi.java
ApplicationSettingsApi.java  CustomersSettingsApi.java  DtosApi.java        GatewayTypesApi.java  MulticastDataDownApi.java  PushConfigurationsApi.java  TasksApi.java
AuthenticatedUserApi.java    DataDownApi.java           EndDevicesApi.java  KpisApi.java          MulticastGroupsApi.java    RncEventsApi.java           UsersApi.java
CapabilitiesApi.java         DataUpApi.java             EventsApi.java      LicensesApi.java      OpenapiApi.java            RolesApi.java               ValidateUserApi.java

\\ \\ All the DTO classes can be found in ''./java_api_client/src/main/java/io/swagger/client/model'':


tda@KLK724-VirtualBox-64:/media/VM_share/SWAGGER/java_api_client2/src/main/java/io/swagger/client/model$ ls
ActionDto.java                          EndDevicePositionDto.java              LnsCustomersLastEventsCountersDto.java
ActionParameterDto.java                 ErrorDto.java                          LnsEventDto.java
ActivityDto.java                        FileDto.java                           LnsGatewayKeyDto.java
AlgorithmDto.java                       FleetCountersDto.java                  MetaDto.java
ApplicationDto.java                     FleetDto.java                          MetaFieldDto.java
ApplicationSettingDto.java              FleetLastEventCounterDto.java          ModemStatisticInterferDto.java
Body1.java                              GatewayConfigurationDto.java           MulticastDataDownDlParametersDto.java
Body2.java                              GatewayConnectionDto.java              MulticastDataDownDto.java
Body3.java                              GatewayControlDto.java                 MulticastDataDownPathDto.java
Body4.java                              GatewayDto.java                        MulticastGroupDto.java
Body5.java                              GatewayEventDto.java                   NumericStatisticDto.java
Body6.java                              GatewayInfoDto.java                    PaginatedDto.java
Body7.java                              GatewayManagementDto.java              ProcessDto.java
Body.java                               GatewayModemDto.java                   ProgressMonitorDto.java
BscDto.java                             GatewayModemStatisticDto.java          PushConfigurationDto.java
CapabilitiesDto.java                    GatewayNumericStatisticsDto.java       PushConfigurationHeaderDto.java
ClusterCountersDto.java                 GatewayPositionDto.java                PushConfigurationHealthDto.java
ClusterDto.java                         GatewaySnmpLogDto.java                 RevisionDto.java
CommandDto.java                         GatewaysStatisticDto.java              RncCustomerLastEventsCountersDto.java
CsvEndDeviceDto.java                    GatewayStatisticsDto.java              RncGatewayEventDto.java
CsvGatewayDto.java                      GatewayTermStatisticsDto.java          RncGatewayLastEventDto.java
CustomerDto.java                        GatewayTypeDto.java                    RoleDto.java
CustomerLastEventsCountersDto.java      GatewayVersionDto.java                 SelectionDto.java
CustomerSettingDto.java                 InstanceDto.java                       SpectrumDto.java
CustomersLastEventsCountersDto.java     ItemDto.java                           TaskDto.java
DataDownDlParametersDto.java            JwtDto.java                            TaskMessageDto.java
DataDownDto.java                        KpiDto.java                            TemplateDto.java
DataDownStatusDto.java                  LastEventCounterDto.java               UserDto.java
DataUpDto.java                          LastEventDto.java                      VersionDto.java
EndDeviceDto.java                       LastOperationDto.java                  WanInterfaceTypeDto.java
EndDeviceLastGatewayDto.java            LastStatisticDto.java                  WebServiceDto.java
EndDeviceMessageDto.java                LicenseDto.java                        WebServiceParameterDto.java
EndDeviceMessageMacCommandDto.java      LinkDto.java
EndDeviceMessageRadioParameterDto.java  LnsCustomerLastEventsCountersDto.java

\\ \\ ===== Importing and compiling the client code in ECLIPSE environment ===== \\ ==== Importing the client code in ECLIPSE environment ==== \\ To import the client code in Eclipse environment: * select Import option * select Maven Project * select the browse option * select the swagger-java-client directory (containing the pom.xml file) {{:wiki3:import_maven_project_4.png?300|}} {{:wiki3:import_maven_project_5.png?500|}} {{:wiki3:import_maven_project_2.png?500|}} {{:wiki3:import_maven_project_6.png?300|}} \\ ==== Building/Compiling ==== Read the README.md file located in the ''java_api_client'' directory. {{ :wiki3:readme.txt |README.md}} === Activating compilation errors on raw type === In Eclipse, right click on ''projet -> properties, java compiler -> Errors/warnings > generic types -> use of a raw type''. Choose "error" in the list. {{:wiki3:compiler_raw_type.png?800|}} === Compiling === To compile the client code, select your "swagger-java-client" project, right-click, select "Run As" and then select "Run Configuration": {{:wiki3:compile_maven_swagger_java_client_1.png?600|}} Type the goal of the build process: "compile" and click the ''Run'' button: {{:wiki3:compile_maven_swagger_java_client.png?800|}} The compilation result should be "BUILD SUCCESS": {{:wiki3:compile_maven_swagger_java_client_2.png?900|}} === Fixing compilation errors on raw type === Compilation results are located in ''.\java_api_client\target\surefire-reports'' \\ Select the file you want to see compilation results. \\ \\ ===== Installing the client code library in MAVEN repository ===== To install the client API library to your local Maven repository, simply execute:


mvn clean install

This can be done like that: {{:wiki3:clean_maven_swagger_java_client.png?500|}} {{:wiki3:install_maven_swagger_java_client.png?500|}} This will build swagger-java-client-1.0.0.jar in the ''/target/'' directory. \\ \\ ===== Executing the client code ===== \\ \\ ==== Creating a test project ==== First, create a new MAVEN project: "test-swagger-java-client".\\ Then define a dependency with the swagger-java-client project. \\ To achieve this, right click on the test-swagger-java-client project and select "Maven" then select "Add dependency": {{:wiki3:project_maven_add_dependency.png?800|}} Add the following information: \\ {{:wiki3:project_maven_add_dependency_2.png?500|}} {{:wiki3:project_maven_add_dependency_3.png|}} \\ \\ ==== Testing the Login API client code ==== \\ Replace the "Hello World" code by your testing code: {{:wiki3:hello_world2.png?800|}} Replaced by :


package io.swagger.test_swagger_java_client;

import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.LoginApi;
import io.swagger.client.model.JwtDto;
import io.swagger.client.model.UserDto;
import io.swagger.client.ApiResponse;


public class App {

    public static void main(String[] args) throws ApiException {
    	
      // Say Hello
      System.out.println("Hello world");
        
      String baseApiUrl = "https://wmcintegration.wanesy.com/";
  	 
  	  int connectTimeout = 60000;

  	  // Create an ApiClient per thread
  	  ApiClient client = new ApiClient();

  	  client.setBasePath(baseApiUrl); 	  
  	  client.setConnectTimeout(connectTimeout);
  	  client.setDebugging(true);
      
  	  // Call login method
  	  LoginApi loginApi = new LoginApi(client);
  	  
  	  UserDto body = new UserDto ();
  	  body.setLogin("your_login");
  	  body.setPassword("your_password");
  	  
  	  System.out.println("Login Post");
  	
  	  JwtDto jwt = loginApi.login(body);
	
  	  client.setApiKey("Bearer " + jwt.getToken());
  	  Configuration.setDefaultApiClient(client);
  	 	   	
  	  System.out.println("Test Done");
  	
    }
}

Compile this piece of code and execute it like this : {{:wiki3:run_java_client_test_login_ok_2.png?600|}} The result should be:


Hello world
Login Post
--> POST https://wmcintegration.wanesy.com//gms/application/login HTTP/1.1
Content-Type: application/json; charset=utf-8
Content-Length: 150
Accept: application/json
User-Agent: Swagger-Codegen/1.0.0/java

{"lastName":"","role":"","avatar":"","login":"xxxxx","enabled":false,"firstName":"","password":"xxxxxx","validated":false,"phone":"","email":""}
--> END POST (150-byte body)
<-- HTTP/1.1 201  (462ms)
Server: nginx
Date: Fri, 28 Jun 2019 15:35:11 GMT
Content-Type: application/json; qs=0;charset=UTF-8
Content-Length: 230
Connection: keep-alive
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Access-Control-Expose-Headers: Location
OkHttp-Sent-Millis: 1561736111681
OkHttp-Received-Millis: 1561736111812

{"expiredDate":1561772111781,"tokenType":"Bearer","token":"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ0ZGEiLCJyb2xlIjoiU1VQRVJfQURNSU4iLCJjdXN0b21lcklkIjoxLCJpc3MirtyuzeMiLCJleHAiOjE1NjE3NzIxMTF9.vhYdP3xy0Naqdeiq7Cx_kzd8bMMg6r0ig-aryAKYJZ8"}
<-- END HTTP (230-byte body)
Test Done

This token will be used for next GMS API requests like getCustomers, getGateways, getFleets, getClusters, etc... You can find API samples in ''.\java_api_client\docs'' \\ \\ ==== Testing the Customer API client code ==== \\ === Modifying the CustomersAPI === \\ Modify the **CustomersAPi** class located in ''./java_api_client/src/main/java/io/swagger/client/api/CustomerApi.java'' to make it generic: == Modifying the getCustomers API ==


    public PaginatedDto getCustomers(String fields, String page, String pageSize, String search, String sort) throws ApiException {
        ApiResponse resp = getCustomersWithHttpInfo(fields, page, pageSize, search, sort);
        return resp.getData();
    }

becomes


    public PaginatedDto getCustomers(final String fields, final String page, final String pageSize, final String search, final String sort) throws ApiException {
        ApiResponse> resp = getCustomersWithHttpInfo(fields, page, pageSize, search, sort);
        return resp.getData();
    }

== Modifying getCustomersWithHttpInfo API ==


public ApiResponse> getCustomersWithHttpInfo(String fields, String page, String pageSize, String search, String sort) throws ApiException {
        com.squareup.okhttp.Call call = getCustomersValidateBeforeCall(fields, page, pageSize, search, sort, null, null);
        Type localVarReturnType = new TypeToken(){}.getType();
        return apiClient.execute(call, localVarReturnType);
    }

becomes


public ApiResponse> getCustomersWithHttpInfo(final String fields, final String page, final String pageSize, final String search, final String sort) throws ApiException {
        com.squareup.okhttp.Call call = getCustomersValidateBeforeCall(fields, page, pageSize, search, sort, null, null);
        Type localVarReturnType = new TypeToken>(){}.getType();
        return this.apiClient.execute(call, localVarReturnType);
    }

=== Modifying the PaginatedDto class === Modify the **PaginatedDto** class located in ''./java_api_client/src/main/java/io/swagger/client/model/PaginatedDto.java'' to make it generic: * Replace the definition "public class PaginatedDto" to "public class PaginatedDto" * Replace the list member from "private List