Utilisation d'un kit SDK Ruby généré par API Gateway pour une API REST

Note

Ces instructions supposent que vous avez déjà suivi les instructions de Génération des kits SDK pour une API à l'aide de la console API Gateway.

Pour installer, instancier et appeler un kit SDK Ruby généré par API Gateway pour une API REST

1. Décompressez le fichier du kit SDK Ruby téléchargé. La source du kit SDK généré est affichée comme suit.

   

2. Créez un gem Ruby à partir de la source du kit SDK généré, à l'aide des commandes shell suivantes dans une fenêtre de terminal :

   # change to /simplecalc-sdk directory
   cd simplecalc-sdk
   
   # build the generated gem
   gem build simplecalc-sdk.gemspec

   Ensuite, simplecalc-sdk-1.0.0.gem devient disponible.

3. Installation du gem :

   gem install simplecalc-sdk-1.0.0.gem

4. Créez une application client. Instanciez et initialisez le client du kit SDK Ruby dans l'application :

   require 'simplecalc-sdk'
   client = SimpleCalc::Client.new(
       http_wire_trace: true,
       retry_limit: 5,
       http_read_timeout: 50
   )

   Si l'autorisation de type AWS_IAM est configurée sur l'API, vous pouvez inclure les informations d'identification AWS du mandataire en fournissant accessKey et secretKey au cours de l'initialisation :

   require 'pet-sdk'
   client = Pet::Client.new(
       http_wire_trace: true,
       retry_limit: 5,
       http_read_timeout: 50,
       access_key_id: 'ACCESS_KEY',
       secret_access_key: 'SECRET_KEY'
   )

5. Effectuez des appels d'API via le kit SDK dans l'application.

   Astuce

   Si vous n'êtes pas familiarisé avec les conventions d'appel de méthode de kit SDK, vous pouvez consulter le fichier client.rb dans le dossier lib du kit SDK généré. Le dossier contient la documentation de chaque appel de méthode d'API pris en charge.

   Pour connaître les opérations prises en charge :

   # to show supported operations:
   puts client.operation_names

   Cela génère l'affichage suivant, qui correspond aux méthodes d'API de GET /?a={.}&b={.}&op={.}, GET /{a}/{b}/{op} et POST /, ainsi qu'une charge utile au format {a:"…", b:"…", op:"…"}, respectivement :

   [:get_api_root, :get_ab_op, :post_api_root]

   Pour appeler la méthode d'API GET /?a=1&b=2&op=+, appelez la méthode de kit SDK Ruby suivante :

   resp = client.get_api_root({a:"1", b:"2", op:"+"})

   Pour appeler la méthode d'API POST / avec une charge utile de {a: "1", b: "2", "op": "+"}, appelez la méthode de kit SDK Ruby suivante :

   resp = client.post_api_root(input: {a:"1", b:"2", op:"+"})

   Pour appeler la méthode d'API GET /1/2/+, appelez la méthode de kit SDK Ruby suivante :

   resp = client.get_ab_op({a:"1", b:"2", op:"+"})

   Les appels de méthode de kit SDK réussies renvoient la réponse suivante :

   resp : {
       result: {
           input: {
               a: 1,
               b: 2,
               op: "+"
           },
           output: {
               c: 3
           }
       }
   }