Verwenden Sie einen von API Gateway SDK generierten Ruby für ein REST API

Das folgende Verfahren zeigt, wie Sie einen von API Gateway SDK generierten Ruby verwenden.

Anmerkung

Für diese Anleitungen müssen Sie die Anleitungen unter Generieren SDKs für REST APIs im API Gateway ausgeführt haben.

Um einen von API Gateway SDK generierten Ruby für einen zu installieren, zu instanziieren und aufzurufen REST API

1. Entpacken Sie die heruntergeladene Ruby-Datei. SDK Die generierte SDK Quelle wird wie folgt angezeigt.

   

2. Erstellen Sie mit den folgenden Shell-Befehlen in einem Terminalfenster ein Ruby-Gem aus der generierten SDK Quelle:

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

   Anschließend ist simplecalc-sdk-1.0.0.gem verfügbar.

3. Installieren Sie das Gem:

   gem install simplecalc-sdk-1.0.0.gem

4. Erstellen Sie eine Client-Anwendung. Instanziieren und initialisieren Sie den SDK Ruby-Client in der App:

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

   Wenn die API Autorisierung dieses AWS_IAM Typs konfiguriert ist, können Sie die AWS Anmeldeinformationen des Aufrufers angeben, indem Sie accessKey und secretKey während der Initialisierung angeben:

   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. APITelefonieren Sie über die SDK in der App.

   Tipp

   Wenn Sie mit den Konventionen für SDK Methodenaufrufe nicht vertraut sind, können Sie die client.rb Datei im generierten SDK lib Ordner überprüfen. Der Ordner enthält die Dokumentation aller unterstützten API Methodenaufrufe.

   So erkennen Sie unterstützte Operationen:

   # to show supported operations:
   puts client.operation_names

   Das Ergebnis ist die folgende Anzeige, die den API Methoden von GET /?a={.}&b={.}&op={.} GET /{a}/{b}/{op}POST /, und sowie jeweils einer Payload des {a:"…", b:"…", op:"…"} Formats entspricht:

   [:get_api_root, :get_ab_op, :post_api_root]

   Um die GET /?a=1&b=2&op=+ API Methode aufzurufen, rufen Sie die folgende SDK Ruby-Methode auf:

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

   Um die POST / API Methode mit einer Nutzlast von aufzurufen{a: "1", b: "2", "op": "+"}, rufen Sie die folgende Ruby-Methode auf: SDK

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

   Rufen Sie die folgende GET /1/2/+ API Ruby-Methode auf, um die Methode aufzurufen: SDK

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

   Die erfolgreichen SDK Methodenaufrufe geben die folgende Antwort zurück:

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