Génération de kits SDK pour une ressource d'API

Outils et versions utilisés dans cet exemple :

• Gradle 6.5
• Maven 3.6.3
• Android Studio 4.1.2

Pour utiliser un kit SDK Android généré par API Gateway à partir du fichier de description d'API d'une ressource d'API, procédez comme suit :

1. Téléchargez le fichier ZIP contenant le kit SDK Android généré par API Gateway, puis extrayez son contenu.
2. Dans le répertoire racine extrait du fichier ZIP, installez le kit SDK généré dans le référentiel Maven local en exécutant la commande suivante :

   mvn clean install

3. Décidez quel projet Android utilisera le SDK Android généré. Ouvrez un projet Android existant dont Gradle est le gestionnaire de packages ou créez un nouveau projet Android comme suit :

   1. Ouvrez Android Studio. Sous Fichier, accédez à Nouveau et sélectionnez Nouveau projet.
   2. Sélectionnez Aucune activité, puis Suivant.
   3. Pour Langue, sélectionnez Java et Terminer.
4. Mettez à jour le fichier build.gradle du module pour ajouter le kit SDK généré en tant que dépendance. Par exemple :

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

   test-project a été ajouté sous dependencies.

5. Exécutez la construction du projet sur Android Studio.
6. Une fois la construction terminée, importez les classes SDK générées et utilisez-les dans une ou plusieurs des classes Java du projet Android. Par exemple :

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

Utilisez l'exemple ci-dessus comme guide, que vous pouvez étendre et adapter pour répondre à vos propres exigences.

Outils et versions utilisés dans cet exemple :

• Maven 3.6.3
• Java 1.8.0

Pour utiliser un kit SDK Java généré par API Gateway à partir du fichier de description d'API d'une ressource d'API, procédez comme suit :

1. Téléchargez le fichier ZIP contenant le kit SDK Java généré par API Gateway, puis extrayez son contenu.
2. Dans le répertoire racine extrait du fichier ZIP, installez le kit SDK généré dans le référentiel Maven local en exécutant la commande suivante :

   mvn clean install

3. Déterminez le projet Maven qui utilisera le kit SDK Java généré. Mettez à jour un projet Maven existant ou créez un nouveau projet Maven en exécutant :

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

4. Mettez à jour le fichier pom.xml du projet Maven pour ajouter le kit SDK généré en tant que dépendance. Par exemple :

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

5. Dans le répertoire racine du projet Maven, exécutez :

   mvn clean install

6. Une fois l'installation de Maven terminée, importez les classes SDK générées et utilisez-les dans le projet Maven. Par exemple :

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

Utilisez l'exemple ci-dessus comme guide, que vous pouvez étendre et adapter pour répondre à vos propres exigences.

Outils et versions utilisés dans cet exemple :

• Npm 6.14.0

Pour utiliser un kit SDK JavaScript généré par la passerelle d'API à partir du fichier de description d'API d'une ressource d'API, procédez comme suit :

1. Téléchargez le fichier ZIP contenant le kit SDK JavaScript généré par API Gateway, puis extrayez son contenu.
2. Dans le répertoire racine extrait du fichier ZIP, exécutez la commande suivante :

   npm install

   npm link

3. Dans le répertoire racine d'un projet npm existant, exécutez :

   npm link <path_to_javascript_client_dir>

   Par exemple :

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

4. Dans le fichier .js à partir duquel appeler les services, importez et utilisez le kit SDK généré. Par exemple :

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

   Dans cet exemple, le nom du kit SDK généré est blog. Recherchez le nom du kit SDK généré dans le fichier package.json extrait.

Utilisez l'exemple ci-dessus comme guide, que vous pouvez étendre et adapter pour répondre à vos propres exigences.

Outils et versions utilisés dans cet exemple :

• XCode 12,4
• Swift 5.3.1
• CocoaPods 1.10.1

Pour utiliser un kit SDK Swift généré par API Gateway à partir du fichier de description d'API d'une ressource d'API, procédez comme suit :

1. Téléchargez le fichier ZIP contenant le kit SDK Swift généré par API Gateway et extrayez son contenu.
2. Déterminez le projet XCode qui utilisera le kit SDK Swift généré. Mettez à jour un projet XCode existant ou créez un projet XCode comme suit :
   1. Ouvrez XCode. Sous Fichier, accédez à Nouveau et sélectionnez Projet.
   2. Sélectionnez App, puis Suivant.
   3. Pour Langue, sélectionnez Swift et Suivant.
   4. Indiquez un emplacement pour le projet et sélectionnez Créer pour créer le projet XCode.
3. Si le répertoire racine du projet XCode ne contient pas déjà de fichier de pod, créez un fichier de pod en exécutant la commande suivante :

   pod init

4. Mettez à jour le fichier de pod pour ajouter une référence au kit SDK généré. Par exemple :

   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. Dans le répertoire racine du projet XCode, exécutez :

   pod install

   Exemple de sortie :

   ~/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. Fermez toutes les instances ouvertes de XCode.
7. Dans le répertoire racine du projet XCode, ouvrez le fichier .xcworkspace pour voir le pod.
8. Mettez à jour n'importe quel fichier SWIFT pour importer le pod et commencer à utiliser le kit SDK généré. Par exemple, mettez à jour le fichier ViewController.swift pour importer le pod mysdk comme suit :

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

Utilisez l'exemple ci-dessus comme guide, que vous pouvez étendre et adapter pour répondre à vos propres exigences.

Outils et versions utilisés dans cet exemple :

• fil 1.22.10

Pour utiliser un kit SDK TypeScript généré par la passerelle d'API à partir du fichier de description d'API d'une ressource d'API, procédez comme suit :

1. Téléchargez le fichier ZIP contenant le kit SDK TypeScript généré par API Gateway, puis extrayez son contenu.
2. Dans le répertoire racine extrait du fichier ZIP, exécutez la commande suivante :

   yarn install

   yarn run build

   yarn link

3. Dans le répertoire racine du projet que vous souhaitez utiliser le kit SDK généré :
   1. Exécution :

      yarn link <project-name>

      où <project name> est le nom du kit SDK généré. Recherchez le nom du kit SDK généré dans le fichier package.json extrait. Par exemple :

      yarn link test-project

   2. Exécution :

      yarn install

4. Mettez à jour le fichier ts du projet que vous souhaitez utiliser le kit SDK généré. Par exemple :

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

Utilisez l'exemple ci-dessus comme guide, que vous pouvez étendre et adapter pour répondre à vos propres exigences.