Generazione di SDK per una risorsa API

Strumenti e versioni utilizzati in questo esempio:

• Gradle 6.5
• Maven 3.6.3
• Android Studio 4.1.2

Per utilizzare un SDK Android generato dal gateway API dal file di descrizione API di una risorsa API, procedere come segue.

1. Scaricare il file zip contenente l'SDK Android generato da API Gateway ed estrarne il contenuto.
2. Nella directory radice estratta dal file zip, installare l'SDK generato nel repository Maven locale eseguendo le operazioni riportate di seguito.

   mvn clean install

3. Decidi quale progetto Android utilizzerà l'SDK Android generato. Aprire un progetto Android esistente con Gradle come gestore di pacchetti oppure creare un nuovo progetto Android come indicato di seguito.

   1. Apri Android Studio. In File, andare a Nuovo e selezionare Nuovo progetto.
   2. Selezionare Nessuna attività e selezionare Avanti.
   3. In Lingua, selezionare Java e selezionare Fine.
4. Aggiornare il file build.gradle del modulo per aggiungere l'SDK generato come dipendenza. Ad esempio:

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

   Si noti che test-project è stato aggiunto in dependencies.

5. Eseguire la build del progetto su Android Studio.
6. Una volta completata la build, importare le classi SDK generate e utilizzarle in una o più classi Java del progetto Android. Ad esempio:

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

Utilizzare l'esempio precedente come guida, che è possibile estendere e adattare per soddisfare le proprie esigenze.

Strumenti e versioni utilizzati in questo esempio:

• Maven 3.6.3
• Java 1.8.0

Per utilizzare un SDK Java generato dal gateway API dal file di descrizione API di una risorsa API, procedere come segue.

1. Scaricare il file zip contenente l'SDK Java generato dal gateway API ed estrarne il contenuto.
2. Nella directory radice estratta dal file zip, installare l'SDK generato nel repository Maven locale eseguendo le operazioni riportate di seguito.

   mvn clean install

3. Decidere quale progetto Maven utilizzerà l'SDK Java generato. Aggiornare un progetto Maven esistente oppure creare un nuovo progetto Maven eseguendo le operazioni riportate di seguito.

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

4. Aggiornare il file pom.xml del progetto Maven per aggiungere l'SDK generato come dipendenza. Ad esempio:

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

5. Nella directory radice del progetto Maven, eseguire:

   mvn clean install

6. Una volta completata l'installazione Maven, importare le classi SDK generate e utilizzarle nel progetto Maven. Ad esempio:

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

Utilizzare l'esempio precedente come guida, che è possibile estendere e adattare per soddisfare le proprie esigenze.

Strumenti e versioni utilizzati in questo esempio:

• Npm 6.14.0

Per utilizzare un SDK JavaScript generato dal gateway API dal file di descrizione API di una risorsa API, procedere come segue.

1. Scaricare il file zip contenente l'SDK JavaScript generato dal gateway API ed estrarne il contenuto.
2. Nella directory radice estratta dal file zip, eseguire:

   npm install

   npm link

3. Nella directory principale di un progetto npm esistente, eseguire:

   npm link <path_to_javascript_client_dir>

   Ad esempio:

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

4. Nel file .js da cui chiamare i servizi, importare e utilizzare l'SDK generato. Ad esempio:

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

   In questo esempio, il nome dell'SDK generato è blog. Cercare nel file package.json estratto il nome del kit SDK generato.

Utilizzare l'esempio precedente come guida, che è possibile estendere e adattare per soddisfare le proprie esigenze.

Strumenti e versioni utilizzati in questo esempio:

• XCode 12.4
• Swift 5.3.1
• CocoaPods 1.10.1

Per utilizzare un SDK Swift generato dal gateway API dal file di descrizione API di una risorsa API, procedere come segue.

1. Scaricare il file zip contenente l'SDK Swift generato da API Gateway ed estrarne il contenuto.
2. Decidere quale progetto XCode utilizzerà l'SDK Swift generato. Aggiornare un progetto XCode esistente oppure creare un nuovo progetto XCode come indicato di seguito.
   1. Aprire XCode. In File, andare a Nuovo e selezionare Progetto.
   2. Selezionare Applicazione e Avanti.
   3. In Lingua, selezionare Swift e selezionare Successivo.
   4. Specificare una posizione per il progetto e selezionare Crea per creare il progetto XCode.
3. Se la directory radice del progetto XCode non contiene già un podfile, creare un podfile eseguendo:

   pod init

4. Aggiornare il podfile per aggiungere un riferimento all'SDK generato. Ad esempio:

   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. Nella directory radice del progetto XCode, eseguire:

   pod install

   Output di esempio:

   ~/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. Chiudere qualsiasi istanza aperta di XCode.
7. Nella directory radice del progetto XCode aprire il file .xcworkspace per visualizzare il pod.
8. Aggiornare qualsiasi file rapido per importare il pod e iniziare a utilizzare l'SDK generato. Ad esempio, aggiornare il file ViewController.swift per importare il pod mysdk come indicato di seguito.

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

Utilizzare l'esempio precedente come guida, che è possibile estendere e adattare per soddisfare le proprie esigenze.

Strumenti e versioni utilizzati in questo esempio:

• filato 1.22.10

Per utilizzare un SDK TypeScript generato dal gateway API dal file di descrizione API di una risorsa API, procedere come segue.

1. Scaricare il file zip contenente l'SDK TypeScript generato dal gateway API ed estrarne il contenuto.
2. Nella directory radice estratta dal file zip, eseguire:

   yarn install

   yarn run build

   yarn link

3. Nella directory radice del progetto che si desidera utilizzare l'SDK generato:
   1. Esegui:

      yarn link <project-name>

      dove <project name> è il nome dell'SDK generato. Cercare nel file package.json estratto il nome del kit SDK generato. Ad esempio:

      yarn link test-project

   2. Esegui:

      yarn install

4. Aggiornare il file ts del progetto che si desidera utilizzare l'SDK generato. Ad esempio:

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

Utilizzare l'esempio precedente come guida, che è possibile estendere e adattare per soddisfare le proprie esigenze.