Verwenden Sie das von API Gateway generierte iOS-SDK für eine REST-API in Objective-C oder Swift

Extrahieren Sie den Inhalt der Gateway-generated API-ZIP-Datei, die Sie zuvor heruntergeladen haben. Wenn Sie die SimpleCalc API verwenden, möchten Sie den entpackten SDK-Ordner möglicherweise in etwas Ähnliches umbenennen. sdk_objc_simple_calc In diesem SDK-Ordner sind eine README.md-Datei und eine Podfile-Datei enthalten. Die README.md-Datei enthält die Anweisungen für die Installation und Verwendung des SDK. Dieses Tutorial bietet Details zu diesen Anweisungen. Die Installation nutzt CocoaPodsden Import der erforderlichen API Gateway Gateway-Bibliotheken und anderer abhängiger AWS Mobile SDK-Komponenten. Aktualisieren Sie die Podfile, um die SDKs in das Xcode-Projekt Ihrer App zu importieren. Der nicht archivierte SDK-Ordner enthält auch einen generated-src-Ordner mit dem Quellcode des generierten SDK Ihrer API.

Starten Sie Xcode und erstellen Sie ein neues Objective-C iOS-Projekt. Notieren Sie das Projektziel. Sie müssen die entsprechende Einstellung in der Podfile vornehmen.

Gehen Sie wie folgt vor, um das mithilfe CocoaPods von AWS Mobile SDK for iOS in das Xcode-Projekt zu importieren:

1. Führen Sie zur Installation CocoaPods den folgenden Befehl in einem Terminalfenster aus:

   sudo gem install cocoapods
   pod setup

2. Kopieren Sie die Podfile-Datei vom extrahierten SDK-Ordner in dasselbe Verzeichnis, das Ihre Xcode Projektdatei enthält. Ersetzen Sie den folgenden Block:

   target '<YourXcodeTarget>' do
       pod 'AWSAPIGateway', '~> 2.4.7'
   end

   mit dem Zielnamen Ihres Projekts:

   target 'app_objc_simple_calc' do
       pod 'AWSAPIGateway', '~> 2.4.7'
   end

   Wenn Ihr Xcode-Projekt bereits eine Datei mit dem Namen Podfile enthält, fügen Sie die folgende Codezeile hinzu:

   pod 'AWSAPIGateway', '~> 2.4.7'

3. Öffnen Sie ein Terminalfenster und führen Sie den folgenden Befehl aus:

   pod install

   Dadurch werden die API Gateway Gateway-Komponente und andere abhängige AWS Mobile SDK-Komponenten installiert.

4. Schließen Sie das Xcode-Projekt und öffnen Sie anschließend die .xcworkspace-Datei, um Xcode neu zu starten.

5. Fügen Sie alle .h- und .m-Dateien aus dem extrahierten SDK-Verzeichnis generated-src Ihrem Xcode-Projekt hinzu.

   

Um die AWS Mobile SDK for iOS Objective-C in Ihr Projekt zu importieren, indem Sie das AWS Mobile SDK explizit herunterladen oder Carthage verwenden, folgen Sie den Anweisungen in der README.mdDatei. Achten Sie darauf, nur eine dieser Optionen zu verwenden, um das AWS Mobile SDK zu importieren.

Importieren Sie die Header-Datei der API-Client-Klasse, um die API-Client-Klasse in der App aufrufbar zu machen:

#import "SIMPLE_CALCSimpleCalc.h"

Durch die Anweisung #import werden auch SIMPLE_CALCInput.h und SIMPLE_CALCResult.h für die beiden Modellklassen importiert.

Instanziieren Sie die API-Client-Klasse:

SIMPLE_CALCSimpleCalcClient *apiInstance = [SIMPLE_CALCSimpleCalcClient defaultClient];

Um Amazon Cognito mit der API zu verwenden, legen Sie, wie im Folgenden gezeigt, Sie die defaultServiceConfiguration-Eigenschaft auf das Standard-AWSServiceManager-Objekt fest, bevor Sie die defaultClient-Methode aufrufen, um das API-Client-Objekt zu erstellen (im vorhergehenden Beispiel gezeigt):

AWSCognitoCredentialsProvider *creds = [[AWSCognitoCredentialsProvider alloc] initWithRegionType:AWSRegionUSEast1 identityPoolId:your_cognito_pool_id];
AWSServiceConfiguration *configuration = [[AWSServiceConfiguration alloc] initWithRegion:AWSRegionUSEast1 credentialsProvider:creds];
AWSServiceManager.defaultServiceManager.defaultServiceConfiguration = configuration;

Rufen Sie die GET /?a=1&b=2&op=+-Methode auf, um 1+2 durchzuführen:

[[apiInstance rootGet: @"+" a:@"1" b:@"2"] continueWithBlock:^id _Nullable(AWSTask * _Nonnull task) {
    _textField1.text = [self handleApiResponse:task];
    return nil;
}];

in der die Hilfsfunktion handleApiResponse:task das Ergebnis als eine Zeichenfolge formatiert, die in einem Textfeld (_textField1) angezeigt werden soll.

- (NSString *)handleApiResponse:(AWSTask *)task {
    if (task.error != nil) {
        return [NSString stringWithFormat: @"Error: %@", task.error.description];
    } else if (task.result != nil && [task.result isKindOfClass:[SIMPLE_CALCResult class]]) {
        return [NSString stringWithFormat:@"%@ %@ %@ = %@\n",task.result.input.a, task.result.input.op, task.result.input.b, task.result.output.c];
    }
    return nil;
}

Die sich ergebende Anzeige ist 1 + 2 = 3.

Rufen Sie den POST / mit einer Nutzlast aus, um 1-2 durchzuführen:

SIMPLE_CALCInput *input = [[SIMPLE_CALCInput alloc] init];
    input.a = [NSNumber numberWithInt:1];
    input.b = [NSNumber numberWithInt:2];
    input.op = @"-";
    [[apiInstance rootPost:input] continueWithBlock:^id _Nullable(AWSTask * _Nonnull task) {
        _textField2.text = [self handleApiResponse:task];
        return nil;
    }];

Die sich ergebende Anzeige ist 1 - 2 = -1.

Rufen Sie GET /{a}/{b}/{op} auf, um 1/2 durchzuführen:

[[apiInstance aBOpGet:@"1" b:@"2" op:@"div"] continueWithBlock:^id _Nullable(AWSTask * _Nonnull task) {
    _textField3.text = [self handleApiResponse:task];
    return nil;
}];

Die sich ergebende Anzeige ist 1 div 2 = 0.5. Hier wird div anstelle von / verwendet, da die einfache Lambda-Funktion im Backend keine URL-kodierten Pfadvariablen verarbeitet.

Extrahieren Sie den Inhalt der Gateway-generated API-ZIP-Datei, die Sie zuvor heruntergeladen haben. Wenn Sie die SimpleCalc API verwenden, möchten Sie den entpackten SDK-Ordner möglicherweise in etwas Ähnliches umbenennen. sdk_swift_simple_calc In diesem SDK-Ordner sind eine README.md-Datei und eine Podfile-Datei enthalten. Die README.md-Datei enthält die Anweisungen für die Installation und Verwendung des SDK. Dieses Tutorial bietet Details zu diesen Anweisungen. Die Installation nutzt CocoaPodsden Import der erforderlichen AWS Mobile SDK-Komponenten. Aktualisieren Sie die Podfile, um die SDKs in das Xcode-Projekt Ihrer Swift-App zu importieren. Der nicht archivierte SDK-Ordner enthält auch einen generated-src-Ordner mit dem Quellcode des generierten SDK Ihrer API.

Starten Sie Xcode und erstellen Sie ein neues iOS Swift-Projekt. Notieren Sie das Projektziel. Sie müssen die entsprechende Einstellung in der Podfile vornehmen.

Gehen Sie wie folgt vor, um die erforderlichen AWS Mobile SDK-Komponenten mithilfe CocoaPods von in das Xcode-Projekt zu importieren:

1. Wenn es nicht installiert ist, installieren Sie es, CocoaPods indem Sie den folgenden Befehl in einem Terminalfenster ausführen:

   sudo gem install cocoapods
   pod setup

2. Kopieren Sie die Podfile-Datei vom extrahierten SDK-Ordner in dasselbe Verzeichnis, das Ihre Xcode Projektdatei enthält. Ersetzen Sie den folgenden Block:

   target '<YourXcodeTarget>' do
       pod 'AWSAPIGateway', '~> 2.4.7'
   end

   mit dem Zielnamen Ihres Projekts wie dargestellt:

   target 'app_swift_simple_calc' do
       pod 'AWSAPIGateway', '~> 2.4.7'
   end

   Wenn Ihr Xcode-Projekt bereits eine Podfile mit dem korrekten Ziel enthält, können Sie einfach die folgende Codezeile zur do ... end-Schleife hinzufügen:

   pod 'AWSAPIGateway', '~> 2.4.7'

3. Öffnen Sie ein Terminalfenster und führen Sie den folgenden Befehl im App-Verzeichnis aus:

   pod install

   Dadurch werden die API Gateway Gateway-Komponente und alle abhängigen AWS Mobile SDK-Komponenten im Projekt der App installiert.

4. Schließen Sie das Xcode-Projekt und öffnen Sie anschließend die *.xcworkspace-Datei, um Xcode neu zu starten.

5. Fügen Sie alle SDK-Header-Dateien (.h) und Swift-Quellcodedateien (.swift) aus dem extrahierten generated-src-Verzeichnis zu Ihrem Xcode-Projekt hinzu.

   

6. Um das Aufrufen der Objective-C Bibliotheken des AWS Mobile SDK von Ihrem Swift-Code-Projekt aus zu ermöglichen, legen Sie den Bridging_Header.h Dateipfad in der Eigenschaft Objective-C Bridging Header unter der Einstellung Swift Compiler — General Ihrer Xcode-Projektkonfiguration fest:

   

   Tipp

   Sie können bridging in das Suchfeld von Xcode eingeben, um die Objective-C Bridging-Header-Eigenschaft zu finden.

7. Erstellen Sie das Xcode-Projekt, um zu überprüfen, dass es ordnungsgemäß konfiguriert wurde, bevor Sie fortfahren. Wenn Ihr Xcode eine neuere Version von Swift verwendet als die, die für das AWS Mobile SDK unterstützt wird, werden Swift-Compilerfehler angezeigt. Setzen Sie in diesem Fall die Eigenschaft Use Legacy Swift Language Version auf Yes in der Einstellung Swift Compiler- Version:

   

Um das AWS Mobile SDK for iOS in Swift in Ihr Projekt zu importieren, indem Sie das AWS Mobile SDK explizit herunterladen oder Carthage verwenden, folgen Sie den Anweisungen in der README.md Datei, die dem SDK-Paket beiliegt. Achten Sie darauf, nur eine dieser Optionen zu verwenden, um das AWS Mobile SDK zu importieren.

Instanziieren Sie die API-Client-Klasse:

let client = SIMPLE_CALCSimpleCalcClient.default()

Um Amazon Cognito mit der API zu verwenden, legen Sie eine AWS Standard-Servicekonfiguration fest (siehe unten), bevor Sie die default Methode aufrufen (siehe oben):

let credentialsProvider = AWSCognitoCredentialsProvider(regionType: AWSRegionType.USEast1, identityPoolId: "my_pool_id")        
let configuration = AWSServiceConfiguration(region: AWSRegionType.USEast1, credentialsProvider: credentialsProvider)        
AWSServiceManager.defaultServiceManager().defaultServiceConfiguration = configuration

Rufen Sie die GET /?a=1&b=2&op=+-Methode auf, um 1+2 durchzuführen:

client.rootGet("+", a: "1", b:"2").continueWithBlock {(task: AWSTask) -> AnyObject? in
    self.showResult(task)
    return nil
}

in der die Hilfsfunktion self.showResult(task) das Ergebnis oder den Fehler auf die Konsole druckt, z. B.:

func showResult(task: AWSTask) {
    if let error = task.error {
        print("Error: \(error)")
    } else if let result = task.result {
        if result is SIMPLE_CALCResult {
            let res = result as! SIMPLE_CALCResult
            print(String(format:"%@ %@ %@ = %@", res.input!.a!, res.input!.op!, res.input!.b!, res.output!.c!))
        } else if result is NSDictionary {
            let res = result as! NSDictionary
            print("NSDictionary: \(res)")
        }
    }
}

In einer Produktion-App können Sie das Ergebnis oder den Fehler in einem Textfeld anzeigen. Die sich ergebende Anzeige ist 1 + 2 = 3.

Rufen Sie den POST / mit einer Nutzlast aus, um 1-2 durchzuführen:

let body = SIMPLE_CALCInput()
body.a=1
body.b=2
body.op="-"
client.rootPost(body).continueWithBlock {(task: AWSTask) -> AnyObject? in
    self.showResult(task)
    return nil
}

Die resultierende Anzeige ist 1 - 2 = -1.

Rufen Sie GET /{a}/{b}/{op} auf, um 1/2 durchzuführen:

client.aBOpGet("1", b:"2", op:"div").continueWithBlock {(task: AWSTask) -> AnyObject? in
    self.showResult(task)
    return nil
}

Die sich ergebende Anzeige ist 1 div 2 = 0.5. Hier wird div anstelle von / verwendet, da die einfache Lambda-Funktion im Backend keine URL-kodierten Pfadvariablen verarbeitet.