Gerando SDKs para um Recurso de API

Ferramentas e versões usadas neste exemplo:

• Gradle 6.5
• Maven 3.6.3
• Estúdio Android 4.1.2

Para usar um SDK do Android que o Gateway de API gerou com base no arquivo de descrição da API de um recurso de API:

1. Faça download do arquivo zip que contém o Android SDK gerado pelo API Gateway e extraia seu conteúdo.
2. No diretório raiz extraído do arquivo zip, instale o SDK gerado no repositório local do Maven executando:

   mvn clean install

3. Decida qual projeto do Android usará o SDK gerado do Android. Abra um projeto Android existente que tenha o Gradle como gerenciador de pacotes ou crie um novo projeto Android da seguinte forma:

   1. Abra o Android Studio. Em Arquivo, vá para Novo e selecione Novo Projeto.
   2. Selecione Nenhuma Atividade e Próximo.
   3. Para Idioma, selecione Java e Finalizar.
4. Atualize o arquivo build.gradle do módulo para adicionar o SDK gerado como uma dependência. Por exemplo:

   plugins {
       id 'com.android.application'
   }
   
   android {
       compileSdkVersion 29
       buildToolsVersion "30.0.3"
   
       defaultConfig {
           applicationId "com.example.myapplication"
           minSdkVersion 21
           targetSdkVersion 29
           versionCode 1
           versionName "1.0"
   
           testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
           // 2) Connect JUnit 5 to the runner
           testInstrumentationRunnerArgument "runnerBuilder", "de.mannodermaus.junit5.AndroidJUnit5Builder"
       }
   
       buildTypes {
           release {
               minifyEnabled false
               proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
           }
       }
       compileOptions {
           sourceCompatibility JavaVersion.VERSION_1_8
           targetCompatibility JavaVersion.VERSION_1_8
       }
   }
   
   apply plugin: "de.mannodermaus.android-junit5"
   
   dependencies {
       implementation 'com.android.support:multidex:1.0.3'
   
       implementation 'androidx.appcompat:appcompat:1.1.0'
       implementation 'com.google.android.material:material:1.1.0'
       implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
   
       androidTestImplementation 'androidx.test.ext:junit:1.1.1'
       androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
       implementation("com.mock:test-project:1.0.1")
   
   }
   

   Observe que test-project foi adicionado em dependencies.

5. Execute o build do projeto no Android Studio.
6. Quando o build for concluído, importe as classes SDK geradas e use-as em uma ou mais classes Java do projeto Android. Por exemplo:

   package com.example.myapplication;
   
   import android.annotation.SuppressLint;
   import android.content.Context;
   import android.os.AsyncTask;
   import android.widget.Toast;
   
   import com.mock.testproject.api.UserV1;
   import com.mock.testproject.api.UsersApi;
   
   public class NetworkTask extends AsyncTask<String,String,String> {
   
       @SuppressLint("StaticFieldLeak")
       private final Context context;
   
       public NetworkTask(Context context) {
           this.context = context;
       }
   
       @Override
       protected String doInBackground(String... strings) {
           try{
               UsersApi usersApi = new UsersApi();
               usersApi.setBasePath("https://0eff7c6c85cc.ngrok.io");
               UserV1 a = usersApi.getUsersUsername("a");
               return a.toString();
           }catch (Exception e){
               e.printStackTrace();
               return e.getMessage();
           }
       }
   
       @Override
       protected void onPostExecute(String s) {
           super.onPostExecute(s);
           Toast.makeText(context, s, Toast.LENGTH_LONG).show();
       }
   }
   

Use o exemplo acima como um guia, que você pode estender e adaptar para atender aos seus próprios requisitos.

Ferramentas e versões usadas neste exemplo:

• Maven 3.6.3
• Java 1.8.0

Para usar um SDK Java que o Gateway de API gerou com base no arquivo de descrição da API de um recurso de API:

1. Faça download do arquivo zip que contém o SDK Java que o Gateway de API gerou e extraia seu conteúdo.
2. No diretório raiz extraído do arquivo zip, instale o SDK gerado no repositório local do Maven executando:

   mvn clean install

3. Decida qual projeto do Maven usará o Java SDK gerado. Atualize um projeto Maven existente ou crie um novo projeto Maven executando:

   mvn -B archetype:generate -DarchetypeGroupdId=org.apache.maven.archetypes -DgroupId=examples.com.testApp -DartifactId=test-maven-project

4. Atualize o arquivo pom.xml do projeto Maven para adicionar o SDK gerado como uma dependência. Por exemplo:

   <dependency>
     <groupId>com.mock.test</groupId>
     <artifactId>integration-java</artifactId>
     <version>1.0.0</version>
     <scope>compile</scope>
   </dependency>
   
   

5. No diretório raiz do projeto Maven, execute:

   mvn clean install

6. Quando a instalação do Maven estiver concluída, importe as classes SDK geradas e use-as no projeto do Maven. Por exemplo:

   import com.mock.test.integration.ApiClient;
   import com.mock.test.integration.ApiException;
   import com.mock.test.integration.api.UsersApi;
   import com.mock.test.integration.model.UserV1;
   
   public class SdkTest {
   
       private String basePath;
       private UsersApi usersApi;
       private UsersApi loggedInUsersApi;
   
       public void setUpAndListUsers(){
           ApiClient loggedInClient = new ApiClient();
           loggedInClient.setPassword("password");
           loggedInClient.setUsername("username");
           loggedInUsersApi = new UsersApi(loggedInClient);
                   List<UserV1> users = loggedInUsersApi.getUsers();
   	}
         }
   

Use o exemplo acima como um guia, que você pode estender e adaptar para atender aos seus próprios requisitos.

Ferramentas e versões usadas neste exemplo:

• Npm 6.14.0

Para usar um SDK JavaScript que o Gateway de API gerou com base no arquivo de descrição da API de um recurso de API:

1. Faça download do arquivo zip que contém o SDK JavaScript gerado pelo Gateway de API e extraia seu conteúdo.
2. No diretório raiz extraído do arquivo zip, execute:

   npm install

   npm link

3. No diretório raiz de um projeto npm existente, execute:

   npm link <path_to_javascript_client_dir>

   Por exemplo:

   npm link "/Users/ajay.d.dubey/Downloads/Simple API overview_JAVASCRIPT_v26544725374050339058" 

4. No arquivo .js do qual chamar os serviços, importe e use o SDK gerado. Por exemplo:

   const Blog = require("blog");
   const apiClient = new Blog.ApiClient();
   apiClient.defaultHeaders = { authorization: "audio/basic" };
   apiInstance = new Blog.UsersApi(apiClient);
   
   //get user
   apiInstance.getUsersUsername(
       "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
       (error, data, response) => {
           if (error) throw error;
   	      console.log(response.statusCode);
           console.log(response)
      }
   );
   
   //put user
   let opts = {
       userV1: new Blog.UserV1(
           "Test",
           "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
           "password",
           "a@b.com"
       ),
   };
   apiInstance.putUsersUsername(
       "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
       opts,
       (error, data, response) => {
           if (error) throw error;
   	      console.log(response.statusCode);
           console.log(response)
       }
   );
   

   Neste exemplo, o nome do SDK gerado é blog. Procure no arquivo package.json extraído o nome do SDK gerado.

Use o exemplo acima como um guia, que você pode estender e adaptar para atender aos seus próprios requisitos.

Ferramentas e versões usadas neste exemplo:

• XCode 12.4
• Swift 5.3.1
• CocoaPods 1.10.1

Para usar um SDK Swift que o Gateway de API gerou com base no arquivo de descrição da API de um recurso de API:

1. Faça download do arquivo zip que contém o SDK Swift que o Gateway de API gerou e extraia seu conteúdo.
2. Decida qual projeto XCode usará o Swift SDK gerado. Atualize um projeto XCode existente ou crie um novo projeto XCode da seguinte forma:
   1. Abra XCode. Em Arquivo, vá para Novo e selecione Projeto.
   2. Selecione Aplicativo e Próximo.
   3. Para Idioma, selecione Alternar e selecione Próximo.
   4. Especifique um local para o projeto e selecione Criar para criar o projeto XCode.
3. Se o diretório raiz do projeto XCode ainda não contiver um Podfile, crie um Podfile executando:

   pod init

4. Atualize o Podfile para adicionar uma referência ao SDK gerado. Por exemplo:

   target 'test-project-3' do
     		# Comment the next line if you don't want to use dynamic frameworks
     		use_frameworks!
     		# Pods for test-project-3
   			pod 'mysdk', :path => '/Users/ajay.d.dubey/workspace-2/swift/Blog_SWIFT_1.0.01209182890182739216'
   		end
   

5. No diretório raiz do projeto XCode, execute:

   pod install

   Exemplo de saída:

   ~/workspace-2/swift/test-project-3 on main ?1 ❯ pod install                    took 1m 4s at 09:50:31
   Analyzing dependencies
   Downloading dependencies
   Installing mysdk (1.0.0)
   Generating Pods project
   Integrating client project
   
   [!] Please close any current Xcode sessions and use `test-project-3.xcworkspace` for this project from now on.
   Pod installation complete! There is 1 dependency from the Podfile and 1 total pod installed.
   
   [!] Automatically assigning platform `iOS` with version `14.4` on target `test-project-3` because no platform was specified. Please specify a platform for this target in your Podfile. See `https://guides.cocoapods.org/syntax/podfile.html#platform`.
   

6. Feche todas as instâncias abertas de XCode.
7. No diretório raiz do projeto XCode, abra o arquivo .xcworkspace para ver o pod.
8. Atualize qualquer arquivo swift para importar o pod e comece a usar o SDK gerado. Por exemplo, atualize o arquivo ViewController.swift para importar o pod mysdk da seguinte forma:

   import UIKit
   import mysdk
   
   class ViewController: UIViewController {
   
       override func viewDidLoad() {
   
           mysdkAPI.credential = URLCredential.init(user: "username", password: "password", persistence: .permanent)
           mysdkAPI.customHeaders = ["Content-Type":"application/json","Authorization":"Basic 1234"]
           mysdk.UsersAPI.getUsers(completion: getUsers)
           
           mysdk.UsersAPI.getUsersUsername(username: "046B6C7F-0B8A-43B9-B35D-6489E6DAEE91", completion: responseUserUsername)    
           
          }
     func getUsers(users :[mysdk.UserV1]?, error:Error?) -> Void{
           print("Attempting fetching user details:")
           print(users)
          }
       
     func responseUserUsername(user :mysdk.UserV1?, error:Error?){
     print("Attempting fetching user with username:")
     print("Successful Request")
     print (user)
           
   		}
   

Use o exemplo acima como um guia, que você pode estender e adaptar para atender aos seus próprios requisitos.

Ferramentas e versões usadas neste exemplo:

• fio 1.22.10

Para usar um SDK TypeScript que o Gateway de API gerou com base no arquivo de descrição da API de um recurso de API:

1. Faça download do arquivo zip que contém o SDK TypeScript gerado pelo Gateway de API e extraia seu conteúdo.
2. No diretório raiz extraído do arquivo zip, execute:

   yarn install

   yarn run build

   yarn link

3. No diretório raiz do projeto que você deseja usar o SDK gerado:
   1. Execução:

      yarn link <project-name>

      em que <project name> é o nome do SDK gerado. Procure no arquivo package.json extraído o nome do SDK gerado. Por exemplo:

      yarn link test-project

   2. Execução:

      yarn install

4. Atualize o arquivo ts do projeto que você deseja usar o SDK gerado. Por exemplo:

   const Blog = require("blog");
   const expect = require("chai").expect;
   let apiInstance;
   let apiInstanceWithoutHeader;
   
   before(function () {
       const apiClient = new Blog.ApiClient();
       apiClient.defaultHeaders = { authorization: "audio/basic" };
       apiInstance = new Blog.UsersApi(apiClient);
       apiInstanceWithoutHeader = new Blog.UsersApi();
   });
   
   describe("UsersApi", function () {
       it("should call add delete username successfully", function (done) {
           apiInstance.deleteUsersUsername(
               "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
               (error, data, response) => {
                   if (error) throw error;
                   console.log(response.statusCode);
                   console.log(response)
                   expect(response.statusCode).to.equal(204);
                   expect(data).to.equal(null);
                   done();
               }
           );
       });
       it("should update user details successfully", function (done) {
           let opts = {
               userV1: new Blog.UserV1(
                   "Test",
                   "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
                   "password",
                   "a@b.com"
               ),
           };
           apiInstance.putUsersUsername(
               "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
               opts,
               (error, data, response) => {
                   if (error) throw error;
                   expect(response.statusCode).to.equal(202);
                   expect(data).to.not.null;
                   done();
               }
           );
       });
   
       });
   
   

Use o exemplo acima como um guia, que você pode estender e adaptar para atender aos seus próprios requisitos.