Utilisez un Ruby SDK généré par API Gateway pour un REST API

La procédure suivante montre comment utiliser un Ruby SDK généré par API Gateway.

Note

Ces instructions supposent que vous avez déjà suivi les instructions de Générer SDKs pour REST APIs dans API Gateway.

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

1. Décompressez le SDK fichier Ruby téléchargé. La SDK source générée s'affiche comme suit.

   

2. Créez un Ruby Gem à partir de la SDK source générée, en utilisant les 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 SDK client Ruby dans l'application :

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

   Si le AWS_IAM type d'autorisation API has est configuré, vous pouvez inclure les informations d' AWS identification de l'appelant en fournissant accessKey et secretKey lors 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. Passez API des appels via SDK l'application.

   Astuce

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

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

   # to show supported operations:
   puts client.operation_names

   Il en résulte l'affichage suivant, correspondant aux API méthodes de GET /?a={.}&b={.}&op={.}GET /{a}/{b}/{op}, etPOST /, plus une charge utile du {a:"…", b:"…", op:"…"} format, respectivement :

   [:get_api_root, :get_ab_op, :post_api_root]

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

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

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

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

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

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

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

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