使用由API網關SDK生成的 Ruby REST API

下列程序顯示如何使用API閘道SDK產生的 Ruby。

注意

這些說明假設您已完成「RESTAPIs在API閘SDKs道中產生」中的說明。

要安裝，實例化和調用由API網關SDK生成的 Ruby REST API

1. 解壓縮下載的 Ruby SDK 文件。產生的SDK來源如下所示。

   

2. 在終端窗口中使用以下 shell 命令，從生成的SDK源代碼構建 Ruby Gem：

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

   在此之後，simplecalc-sdk-1.0.0.gem 即可使用。

3. 安裝 gem：

   gem install simplecalc-sdk-1.0.0.gem

4. 建立用戶端應用程式。在應用程序中實例化和初始化 Ruby SDK 客戶端：

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

   如果API已配置AWS_IAM類型的授權，則可以通過提供accessKey和初始化secretKey期間包含呼叫者的 AWS 認證：

   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. 透過應用程式SDK中的API撥打電話。

   提示

   如果您不熟悉SDK方法調用約定，則可以查看生成的client.rb文件SDKlib夾中的文件。該文件夾包含每個支持的API方法調用的文檔。

   探索受支援的操作：

   # to show supported operations:
   puts client.operation_names

   這將導致以下顯示，分別對應於GET /?a={.}&b={.}&op={.}GET /{a}/{b}/{op}POST /、和的API方法以及該{a:"…", b:"…", op:"…"}格式的有效負載：

   [:get_api_root, :get_ab_op, :post_api_root]

   要調用該GET /?a=1&b=2&op=+API方法，請調用以下 Ruby SDK 方法：

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

   若要叫用有效負載的POST /API方法{a: "1", b: "2", "op": "+"}，請呼叫下列 Ruby SDK 方法：

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

   要調用該GET /1/2/+API方法，請調用以下 Ruby SDK 方法：

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

   成功的SDK方法調用返回以下響應：

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