Generación de SDK para un recurso de API

Herramientas y versiones utilizadas en este ejemplo:

• Gradle 6.5
• Maven 3.6.3
• Android Studio 4.1.2

Para utilizar un SDK de Android que API Gateway ha generado a partir del archivo de descripción de API de un recurso de API:

1. Descargue el archivo zip que contiene el SDK de Android generado por API Gateway y extraiga su contenido.
2. En el directorio raíz extraído del archivo zip, instale el SDK generado en el repositorio de Maven local ejecutando:

   mvn clean install

3. Decida qué proyecto de Android utilizará el SDK de Android generado. Abra un proyecto existente de Android que tenga Gradle como gestor de paquetes o cree un nuevo proyecto de Android de la siguiente manera:

   1. Abra Android Studio. En Archivo, vaya a Nuevo y seleccione Nuevo proyecto.
   2. Seleccione Sin actividad y seleccione Siguiente.
   3. En Idioma, seleccione Java y Terminar.
4. Actualice el archivo build.gradle del módulo para agregar el SDK generado como dependencia. Por ejemplo:

   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")
   
   }
   

   Tenga en cuenta que test-project se ha agregado en dependencies.

5. Ejecute la creación del proyecto en Android Studio.
6. Una vez finalizada la creación, importe las clases de SDK generadas y utilícelas en una o más de las clases Java del proyecto Android. Por ejemplo:

   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();
       }
   }
   

Utilice el ejemplo anterior como guía, que puede ampliar y adaptar para satisfacer sus propios requisitos.

Herramientas y versiones utilizadas en este ejemplo:

• Maven 3.6.3
• 1.8.0 de Java

Para utilizar un SDK de Java que API Gateway ha generado a partir del archivo de descripción de API de un recurso de API:

1. Descargue el archivo zip que contiene el SDK de Java generado por API Gateway y extraiga su contenido.
2. En el directorio raíz extraído del archivo zip, instale el SDK generado en el repositorio de Maven local ejecutando:

   mvn clean install

3. Decida qué proyecto de Maven utilizará el SDK de Java generado. Actualice un proyecto de Maven existente o cree un nuevo proyecto de Maven ejecutando:

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

4. Actualice el archivo pom.xml del proyecto de Maven para agregar el SDK generado como dependencia. Por ejemplo:

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

5. En el directorio raíz del proyecto de Maven, ejecute:

   mvn clean install

6. Una vez finalizada la instalación de Maven, importe las clases de SDK generadas y utilícelas en el proyecto de Maven. Por ejemplo:

   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();
   	}
         }
   

Utilice el ejemplo anterior como guía, que puede ampliar y adaptar para satisfacer sus propios requisitos.

Herramientas y versiones utilizadas en este ejemplo:

• Npm 6.14.0

Para utilizar un SDK JavaScript que API Gateway ha generado a partir del archivo de descripción de API de un recurso de API:

1. Descargue el archivo zip que contiene el SDK JavaScript generado por API Gateway y extraiga su contenido.
2. En el directorio raíz extraído del archivo zip, ejecute:

   npm install

   npm link

3. En el directorio raíz de un proyecto npm existente, ejecute:

   npm link <path_to_javascript_client_dir>

   Por ejemplo:

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

4. En el archivo .js desde el que llamar a los servicios, importe y utilice el SDK generado. Por ejemplo:

   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)
       }
   );
   

   En este ejemplo, el nombre del SDK generado es blog. Busque en el archivo package.json extraído el nombre del SDK generado.

Utilice el ejemplo anterior como guía, que puede ampliar y adaptar para satisfacer sus propios requisitos.

Herramientas y versiones utilizadas en este ejemplo:

• XCode 12.4
• Swift5.3.1
• CocoaPods 1.10.1

Para utilizar un SDK de Swift que API Gateway ha generado a partir de un archivo de descripción de API de un recurso de API:

1. Descargue el archivo zip que contiene el SDK de Swift generado por API Gateway y extraiga su contenido.
2. Decida qué proyecto XCode utilizará el SDK de Swift generado. Actualice un proyecto XCode existente o cree un nuevo proyecto XCode de la siguiente manera:
   1. Abra XCode. En Archivo, vaya a Nuevo y seleccione Proyecto.
   2. Seleccione Aplicación y seleccione Siguiente.
   3. En Idioma, seleccione Swift y seleccione Siguiente.
   4. Especifique una ubicación para el proyecto y seleccione Crear para crear el proyecto XCode.
3. Si el directorio raíz del proyecto XCode aún no contiene un Podfile, cree un Podfile ejecutando:

   pod init

4. Actualice el podfile para agregar una referencia al SDK generado. Por ejemplo:

   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. En el directorio raíz del proyecto XCode, ejecute:

   pod install

   Resultado de ejemplo:

   ~/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. Cierre las instancias abiertas de XCode.
7. En el directorio raíz del proyecto XCode, abra el archivo .xcworkspace para ver el pod.
8. Actualice cualquier archivo SWIFT para importar el pod y empiece a utilizar el SDK generado. Por ejemplo, actualice el archivo ViewController.swift para importar el pod mysdk de la siguiente manera:

   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)
           
   		}
   

Utilice el ejemplo anterior como guía, que puede ampliar y adaptar para satisfacer sus propios requisitos.

Herramientas y versiones utilizadas en este ejemplo:

• hilo 1.22.10

Para utilizar un SDK TypeScript que API Gateway ha generado a partir del archivo de descripción de API de un recurso de API:

1. Descargue el archivo zip que contiene el SDK TypeScript generado por API Gateway y extraiga su contenido.
2. En el directorio raíz extraído del archivo zip, ejecute:

   yarn install

   yarn run build

   yarn link

3. En el directorio raíz del proyecto que desea utilizar el SDK generado:
   1. Ejecutar:

      yarn link <project-name>

      donde <project name> es el nombre del SDK generado. Busque en el archivo package.json extraído el nombre del SDK generado. Por ejemplo:

      yarn link test-project

   2. Ejecutar:

      yarn install

4. Actualice el archivo ts del proyecto que desea utilizar el SDK generado. Por ejemplo:

   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();
               }
           );
       });
   
       });
   
   

Utilice el ejemplo anterior como guía, que puede ampliar y adaptar para satisfacer sus propios requisitos.