Usa un Ruby SDK generato da API Gateway per un REST API

Per installare, creare un'istanza e chiamare un Ruby SDK generato da Gateway per un API REST API

1. Decomprimi il file Ruby scaricato. SDK La SDK fonte generata è mostrata come segue.

   

2. Crea un Ruby Gem dalla SDK fonte generata, usando i seguenti comandi di shell in una finestra di terminale:

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

   Dopo questa operazione, simplecalc-sdk-1.0.0.gem diventa disponibile.

3. Installa la gem:

   gem install simplecalc-sdk-1.0.0.gem

4. Crea un'applicazione client. Crea un'istanza e inizializza il client Ruby SDK nell'app:

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

   Se è configurata l'autorizzazione API has del AWS_IAM tipo, puoi includere le AWS credenziali del chiamante fornendo e durante l'inizializzazione: accessKey secretKey

   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. Effettua API chiamate tramite l'app. SDK

   Suggerimento

   Se non conosci le convenzioni relative alle chiamate ai SDK metodi, puoi esaminare il client.rb file nella SDK lib cartella generata. La cartella contiene la documentazione di ogni chiamata al API metodo supportata.

   Per conoscere le operazioni supportate:

   # to show supported operations:
   puts client.operation_names

   Ciò si traduce nella seguente visualizzazione, corrispondente rispettivamente ai API metodi e GET /{a}/{b}/{op}POST /, più un payload del {a:"…", b:"…", op:"…"} formato: GET /?a={.}&b={.}&op={.}

   [:get_api_root, :get_ab_op, :post_api_root]

   Per richiamare il GET /?a=1&b=2&op=+ API metodo, chiamate il seguente metodo RubySDK:

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

   Per richiamare il POST / API metodo con un payload di{a: "1", b: "2", "op": "+"}, chiamate il seguente metodo Ruby: SDK

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

   Per richiamare il GET /1/2/+ API metodo, chiamate il seguente metodo Ruby: SDK

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

   Le chiamate al SDK metodo riuscite restituiscono la seguente risposta:

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