Utilisation d’un kit SDK iOS généré par API Gateway pour une API REST dans Objective-C ou Swift

Extrayez le contenu du fichier .zip généré par API Gateway que vous avez précédemment téléchargé. A l’aide de l’API SimpleCalc, vous pouvez renommer le dossier du kit SDK décompressé sous la forme sdk_objc_simple_calc. Dans ce dossier de kit SDK se trouvent un fichier README.md et un fichier Podfile. Le fichier README.md contient les instructions pour installer et utiliser le kit SDK. Ce didacticiel fournit les détails de ces instructions. L’installation tire parti de CocoaPods pour importer les bibliothèques API Gateway requises et d’autres composants du Kit SDK AWS Mobile dépendants. Vous devez mettre à jour le fichier Podfile pour importer les kits SDK dans le projet Xcode de votre application. Le dossier de kit SDK décompressé contient également un dossier generated-src qui contient le code source du kit SDK généré de votre API.

Lancez Xcode et créez un projet iOS Objective-C. Notez la cible du projet. Vous en avez besoin pour la définir dans le fichier Podfile.

Pour importer le AWS Mobile SDK for iOS dans le projet Xcode à l’aide de CocoaPods, procédez comme suit :

1. Installez CocoaPods en exécutant la commande suivante dans une fenêtre de terminal :

   sudo gem install cocoapods
   pod setup

2. Copiez le fichier Podfile à partir du dossier de kit SDK extrait dans le même répertoire contenant votre fichier de projet Xcode. Remplacez le bloc suivant :

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

   avec le nom cible de votre projet :

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

   Si votre projet Xcode contient déjà un fichier nommé Podfile, ajoutez-lui la ligne de code suivante :

   pod 'AWSAPIGateway', '~> 2.4.7'

3. Ouvrez une fenêtre de terminal et exécutez la commande suivante :

   pod install

   Cette opération installe le composant API Gateway et d’autres composants dépendants d’AWS Mobile SDK.

4. Fermez le projet Xcode et ouvrez le fichier .xcworkspace pour relancer Xcode.

5. Ajoutez tous les fichiers .h et .m du répertoire generated-src du kit SDK extrait dans votre projet Xcode.

   

Pour importer le AWS Mobile SDK for iOS Objective-C dans votre projet en téléchargeant explicitement le kit SDK AWS Mobile ou en utilisant Carthage, suivez les instructions du fichier README.md. Veillez à utiliser une seule de ces options pour importer l’AWS Mobile SDK.

Importez le fichier d’en-tête de la classe de client d’API pour que la classe de client d’API puisse être appelée dans l’application :

#import "SIMPLE_CALCSimpleCalc.h"

La déclaration #import importe également SIMPLE_CALCInput.h et SIMPLE_CALCResult.h pour les deux classes de modèle.

Instanciez la classe de client d’API :

SIMPLE_CALCSimpleCalcClient *apiInstance = [SIMPLE_CALCSimpleCalcClient defaultClient];

Pour utiliser Amazon Cognito avec l’API, définissez la propriété defaultServiceConfiguration sur l’objet AWSServiceManager par défaut, comme illustré ci-après, avant d’appeler la méthode defaultClient pour créer l’objet de client d’API (comme illustré dans l’exemple précédent) :

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

Appelez la méthode GET /?a=1&b=2&op=+ pour exécuter 1+2 :

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

où handleApiResponse:task de la fonction d’assistant formate le résultat sous forme de chaîne pour l’afficher dans un champ de texte (_textField1).

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

Le résultat qui s’affiche est 1 + 2 = 3.

Appelez la méthode POST / avec une charge utile pour exécuter 1-2 :

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

Le résultat qui s’affiche est 1 - 2 = -1.

Appelez la méthode GET /{a}/{b}/{op} pour exécuter 1/2 :

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

Le résultat qui s’affiche est 1 div 2 = 0.5. Ici, div est utilisé à la place de /, car la fonction Lambda simple du backend ne gère pas les variables de chemin d’URL codée.

Extrayez le contenu du fichier .zip généré par API Gateway que vous avez précédemment téléchargé. A l’aide de l’API SimpleCalc, vous pouvez renommer le dossier du kit SDK décompressé sous la forme sdk_swift_simple_calc. Dans ce dossier de kit SDK se trouvent un fichier README.md et un fichier Podfile. Le fichier README.md contient les instructions pour installer et utiliser le kit SDK. Ce didacticiel fournit les détails de ces instructions. L’installation tire parti de CocoaPods pour importer les composants requis du kit SDK AWS Mobile. Vous devez mettre à jour le fichier Podfile pour importer les kits SDK dans le projet Xcode de votre application Swift. Le dossier de kit SDK décompressé contient également un dossier generated-src qui contient le code source du kit SDK généré de votre API.

Lancez Xcode et créez un projet iOS Swift. Notez la cible du projet. Vous en avez besoin pour la définir dans le fichier Podfile.

Pour importer les composants AWS Mobile SDK requis dans le projet Xcode à l’aide de CocoaPods, procédez comme suit :

1. Si CocoaPods n’est pas installé, installez-le en exécutant la commande suivante dans une fenêtre de terminal :

   sudo gem install cocoapods
   pod setup

2. Copiez le fichier Podfile à partir du dossier de kit SDK extrait dans le même répertoire contenant votre fichier de projet Xcode. Remplacez le bloc suivant :

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

   avec le nom cible de votre projet comme indiqué :

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

   Si votre fichier de projet Xcode contient un fichier nommé Podfile avec la cible correcte, vous pouvez simplement ajouter la ligne de code suivante à la boucle do ... end :

   pod 'AWSAPIGateway', '~> 2.4.7'

3. Ouvrez une fenêtre de terminal et exécutez la commande suivante dans le répertoire de l’application :

   pod install

   Cette opération installe le composant API Gateway et les autres composants AWS Mobile SDK dépendants dans le projet de l’application.

4. Fermez le projet Xcode et ouvrez le fichier *.xcworkspace pour relancer Xcode.

5. Ajoutez tous les fichiers d’en-tête du kit SDK (.h) et les fichiers de code source Swift (.swift) du répertoire generated-src extrait à votre projet Xcode.

   

6. Pour activer l’appel des bibliothèques Objective-C du kit SDK AWS Mobile à partir de votre projet de code Swift, définissez le chemin d’accès Bridging_Header.h sur la propriété Objective-C Bridging Header (En-tête de transition Objective-C) sous le paramètre Swift Compiler - General (Compilateur Swift - Général) de votre configuration de projet Xcode :

   

   Astuce

   Vous pouvez saisir bridging dans la zone de recherche de Xcode pour localiser la propriété Objective-C Bridging Header (En-tête de transition Objective-C).

7. Créez le projet Xcode pour vérifier qu’il est correctement configuré avant de continuer. Si votre environnement Xcode utilise une version plus récente de Swift que celle prise en charge par l’AWS Mobile SDK, vous obtiendrez des erreurs du compilateur Swift. Dans ce cas, définissez la propriété Use Legacy Swift Language Version sur Yes sous le paramètre Swift Compiler - Version :

   

Pour importer Mobile SDK for iOS AWS dans Swift dans votre projet en téléchargeant explicitement Mobile SDK AWS ou en utilisant Carthage, suivez les instructions du fichier README.md inclus dans le package du kit SDK. Veillez à utiliser une seule de ces options pour importer l’AWS Mobile SDK.

Instanciez la classe de client d’API :

let client = SIMPLE_CALCSimpleCalcClient.default()

Pour utiliser Amazon Cognito avec l’API, définissez une configuration de service AWS par défaut (illustrée ci-dessous) avant d’obtenir la méthode default (illustrée précédemment) :

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

Appelez la méthode GET /?a=1&b=2&op=+ pour exécuter 1+2 :

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

où self.showResult(task) de la fonction d’assistant imprime le résultat ou l’erreur vers la console ; par exemple :

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

Dans une application de production, vous pouvez afficher le résultat ou l’erreur dans un champ de texte. Le résultat qui s’affiche est 1 + 2 = 3.

Appelez la méthode POST / avec une charge utile pour exécuter 1-2 :

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
}

Le résultat qui s’affiche est 1 - 2 = -1.

Appelez la méthode GET /{a}/{b}/{op} pour exécuter 1/2 :

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

Le résultat qui s’affiche est 1 div 2 = 0.5. Ici, div est utilisé à la place de /, car la fonction Lambda simple du backend ne gère pas les variables de chemin d’URL codée.