SDKs für API-Ressourcen generieren

In diesem Beispiel verwendete Tools und Versionen:

• Gradle 6.5
• Maven 3.6.3
• Android-Studio 4.1.2

So verwenden Sie ein Android-SDK, das API Gateway aus der API-Beschreibungsdatei einer API-Ressource generiert hat:

1. Laden Sie die ZIP-Datei mit dem Android-SDK herunter, das von API Gateway generiert wurde, und extrahieren Sie den Inhalt.
2. Installieren Sie im Root-Verzeichnis, das aus der ZIP-Datei extrahiert wurde, das generierte SDK im lokalen Maven-Repository, indem Sie Folgendes ausführen:

   mvn clean install

3. Entscheiden Sie, welches Android-Projekt das generierte Android-SDK verwendet. Öffnen Sie entweder ein vorhandenes Android-Projekt, das Gradle als Paketmanager hat, oder erstellen Sie wie folgt ein neues Android-Projekt:

   1. Öffnen Sie Android Studio. Gehen Sie unter Datei zu Neu, und wählen Sie Neues Projekt aus.
   2. Wählen Sie Keine Aktivität, und wählen Sie Weiter aus.
   3. Wählen Sie unter Sprache die Option Java aus, und wählen Sie Fertigstellen aus.
4. Aktualisieren Sie die Datei build.gradle des Moduls, um das generierte SDK als Abhängigkeit hinzuzufügen. Beispiel:

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

   Beachten Sie, dass test-project unter dependencies hinzugefügt wurde.

5. Führen Sie den Projekt-Build auf Android Studio aus.
6. Wenn der Build abgeschlossen ist, importieren Sie die generierten SDK-Klassen und verwenden sie in mindestens einer der Java-Klassen des Android-Projekts. Beispiel:

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

Verwenden Sie das obige Beispiel als Leitfaden, den Sie erweitern und an Ihre eigenen Anforderungen anpassen können.

In diesem Beispiel verwendete Tools und Versionen:

• Maven 3.6.3
• Java 1.8.0

So verwenden Sie ein Java-SDK, das API Gateway aus der API-Beschreibungsdatei einer API-Ressource generiert hat:

1. Laden Sie die ZIP-Datei mit dem von API Gateway generierten Java-SDK herunter, und extrahieren Sie den Inhalt.
2. Installieren Sie im Root-Verzeichnis, das aus der ZIP-Datei extrahiert wurde, das generierte SDK im lokalen Maven-Repository, indem Sie Folgendes ausführen:

   mvn clean install

3. Entscheiden Sie, welches Maven-Projekt das generierte Java-SDK verwendet. Aktualisieren Sie ein vorhandenes Maven-Projekt, oder erstellen Sie ein neues Maven-Projekt, indem Sie Folgendes ausführen:

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

4. Aktualisieren Sie die Datei pom.xml des Maven-Projekts, um das generierte SDK als Abhängigkeit hinzuzufügen. Beispiel:

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

5. Führen Sie im Root-Verzeichnis des Maven-Projekts Folgendes aus:

   mvn clean install

6. Importieren Sie nach Abschluss der Maven-Installation die generierten SDK-Klassen, und verwenden Sie sie im Maven-Projekt. Beispiel:

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

Verwenden Sie das obige Beispiel als Leitfaden, den Sie erweitern und an Ihre eigenen Anforderungen anpassen können.

In diesem Beispiel verwendete Tools und Versionen:

• Npm 6.14.0

So verwenden Sie ein JavaScript-SDK, das API Gateway aus der API-Beschreibungsdatei einer API-Ressource generiert hat:

1. Laden Sie die ZIP-Datei mit dem von API Gateway generierten JavaScript-SDK herunter, und extrahieren Sie den Inhalt.
2. Führen Sie im Root-Verzeichnis, das aus der ZIP-Datei extrahiert wurde, Folgendes aus:

   npm install

   npm link

3. Führen Sie im Root-Verzeichnis eines vorhandenen npm-Projekts Folgendes aus:

   npm link <path_to_javascript_client_dir>

   Beispiel:

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

4. Importieren und verwenden Sie in der .js-Datei, aus der die Services aufgerufen werden sollen, das generierte SDK. Beispiel:

   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 diesem Beispiel lautet der Name des generierten SDK blog. Suchen Sie in der extrahierten Datei package.json nach dem Namen des generierten SDK.

Verwenden Sie das obige Beispiel als Leitfaden, den Sie erweitern und an Ihre eigenen Anforderungen anpassen können.

In diesem Beispiel verwendete Tools und Versionen:

• XCode 12,4
• Swift 5.3.1
• CocoaPods 1.10.1

So verwenden Sie ein Swift-SDK, das API Gateway aus der API-Beschreibungsdatei einer API-Ressource generiert hat:

1. Laden Sie die ZIP-Datei mit dem Swift-SDK herunter, das von API Gateway generiert wurde, und extrahieren Sie den Inhalt.
2. Entscheiden Sie, welches XCode-Projekt das generierte Swift-SDK verwendet. Aktualisieren Sie ein vorhandenes XCode-Projekt, oder erstellen Sie ein neues XCode-Projekt wie folgt:
   1. Öffnen Sie XCode. Gehen Sie unter Datei zu Neu, und wählen Sie Projekt aus.
   2. Wählen Sie App, Weiter aus.
   3. Wählen Sie unter Sprache die Option Swift aus, und wählen Sie Weiter aus.
   4. Geben Sie einen Speicherort für das Projekt an, und wählen Sie Erstellen aus, um das Projekt XCode zu erstellen.
3. Wenn das Root-Verzeichnis des Projekts XCode noch keine Poddatei enthält, erstellen Sie eine Poddatei, indem Sie Folgendes ausführen:

   pod init

4. Aktualisieren Sie die Poddatei, um eine Referenz zum generierten SDK hinzuzufügen. Beispiel:

   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. Führen Sie im Root-Verzeichnis des Projekts XCode Folgendes aus:

   pod install

   Beispielausgabe:

   ~/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. Schließen Sie alle offenen Instanzen von XCode.
7. Öffnen Sie im Root-Verzeichnis des Projekts XCode die XCWorkspace-Datei, um den Pod anzuzeigen.
8. Aktualisieren Sie eine beliebige Swift-Datei, um den Pod zu importieren, und verwenden Sie das generierte SDK. Beispiel: Aktualisieren Sie die Datei ViewController.swift wie folgt, um den mysdk-Pod zu importieren:

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

Verwenden Sie das obige Beispiel als Leitfaden, den Sie erweitern und an Ihre eigenen Anforderungen anpassen können.

In diesem Beispiel verwendete Tools und Versionen:

• Garn 1.22.10

So verwenden Sie ein TypeScript-SDK, das API Gateway aus der API-Beschreibungsdatei einer API-Ressource generiert hat:

1. Laden Sie die ZIP-Datei mit dem von API Gateway generierten TypeScript-SDK herunter, und extrahieren Sie den Inhalt.
2. Führen Sie im Root-Verzeichnis, das aus der ZIP-Datei extrahiert wurde, Folgendes aus:

   yarn install

   yarn run build

   yarn link

3. Im Root-Verzeichnis des Projekts, das Sie mit dem generierten SDK verwenden möchten:
   1. Ausführen:

      yarn link <project-name>

      Dabei ist <project name> der Name des generierten SDK. Suchen Sie in der extrahierten Datei package.json nach dem Namen des generierten SDK. Beispiel:

      yarn link test-project

   2. Ausführen:

      yarn install

4. Aktualisieren Sie die ts-Datei des Projekts, das Sie mit dem generierten SDK verwenden möchten. Beispiel:

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

Verwenden Sie das obige Beispiel als Leitfaden, den Sie erweitern und an Ihre eigenen Anforderungen anpassen können.