Amazon API Gateway
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

使用 API Gateway 生成的 Ruby 开发工具包

注意

这些说明假设您已完成使用 API Gateway 控制台为 API 生成开发工具包中的说明。

要开始安装,请实例化并调用由 API Gateway 生成的 Ruby 开发工具包

  1. 解压缩下载的 Ruby 开发工具包文件。生成的开发工具包源如下所示。

     将下载的 Ruby 开发工具包文件解压缩到 Ruby 模块中
  2. 从生成的开发工具包源构建 Ruby Gem,在终端窗口中使用以下 shell 命令:

    # 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 开发工具包客户端:

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

    如果 API 已经配置了 AWS_IAM 类型的授权,您可以在初始化期间提供 accessKeysecretKey,包括调用方的 AWS 凭证。

    require 'pet-sdk' client = Pet::Client.new( http_wire_trace: true, retry_limit: 5, http_read_timeout: 50, access_key: 'ACCESS_KEY', secret_key: 'SECRET_KEY' )
  5. 在应用程序中通过开发工具包进行 API 调用。

    提示

    如果您不熟悉开发工具包方法调用约定,可以查看生成的开发工具包 lib 文件夹中的 client.rb 文件。该文件夹包含支持的各个 API 方法调用的文档。

    搜索支持的操作:

    # to show supported operations: puts client.operation_names

    这将生成以下显示内容,分别对应于 GET /?a={.}&b={.}&op={.}GET /{a}/{b}/{op} 的 API 方法,以及 POST /,加上 {a:"…", b:"…", op:"…"} 格式的负载:

    [:get_api_root, :get_ab_op, :post_api_root]

    要调用 GET /?a=1&b=2&op=+ API 方法,请调用以下 Ruby 开发工具包方法:

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

    要使用 {a: "1", b: "2", "op": "+"} 的负载调用 POST / API 方法,请调用以下 Ruby 开发工具包方法:

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

    要调用 GET /1/2/+ API 方法,请调用以下 Ruby 开发工具包方法:

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

    成功的开发工具包方法调用返回以下响应:

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