Menggunakan Ruby SDK yang dihasilkan oleh API Gateway untuk REST API

catatan

Instruksi ini mengasumsikan Anda sudah menyelesaikan instruksi diHasilkan SDK untuk REST API di API Gateway.

Untuk menginstal, membuat instance, dan memanggil Ruby SDK yang dihasilkan oleh API Gateway untuk REST API

1. Buka zip file Ruby SDK yang diunduh. Sumber SDK yang dihasilkan ditampilkan sebagai berikut.

   

2. Buat Ruby Gem dari sumber SDK yang dihasilkan, menggunakan perintah shell berikut di jendela terminal:

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

   Setelah ini, simplecalc-sdk-1.0.0.gem menjadi tersedia.

3. Instal permata:

   gem install simplecalc-sdk-1.0.0.gem

4. Buat aplikasi klien. Buat instance dan inisialisasi klien Ruby SDK di aplikasi:

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

   Jika API memiliki otorisasi AWS_IAM jenis yang dikonfigurasi, Anda dapat menyertakan AWS kredensi pemanggil dengan menyediakan accessKey dan selama inisialisasi: 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. Lakukan panggilan API melalui SDK di aplikasi.

   Tip

   Jika Anda tidak terbiasa dengan konvensi panggilan metode SDK, Anda dapat meninjau client.rb file di folder SDK lib yang dihasilkan. Folder berisi dokumentasi setiap panggilan metode API yang didukung.

   Untuk menemukan operasi yang didukung:

   # to show supported operations:
   puts client.operation_names

   Ini menghasilkan tampilan berikut, sesuai dengan metode API GET /?a={.}&b={.}&op={.}GET /{a}/{b}/{op}, danPOST /, ditambah muatan {a:"…", b:"…", op:"…"} format, masing-masing:

   [:get_api_root, :get_ab_op, :post_api_root]

   Untuk menjalankan metode GET /?a=1&b=2&op=+ API, panggil metode Ruby SDK berikut ini:

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

   Untuk menjalankan metode POST / API dengan payload sebesar{a: "1", b: "2", "op": "+"}, panggil metode Ruby SDK berikut:

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

   Untuk menjalankan metode GET /1/2/+ API, panggil metode Ruby SDK berikut:

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

   Pemanggilan metode SDK yang berhasil mengembalikan respons berikut:

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