Amazon API Gateway
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

Generate the Ruby SDK of an API

To generate the Ruby SDK of an API in API Gateway

  1. Sign in to the API Gateway console at

  2. In the box that contains the name of the API for the stage, choose Stages.

  3. In the Stages pane, choose the name of the stage.

  4. On the SDK Generation tab, for Platform, choose Ruby.

    1. For Service Name, specify the name of your SDK. For example, SimpleCalc. This is used to generate the Ruby Gem namespace of your API. The name must be all letters, (a-zA-Z), without any other special characters or numbers.

    2. For Ruby Gem Name, specify the name of the Ruby Gem to contain the generated SDK source code for your API. By default it is the lower-cased service name plus the -sdk suffix; for example simplecalc-sdk.

    3. For Ruby Gem Version, specify a version number for the generated Ruby Gem. By default, it is set to 1.0.0.

  5. Choose Generate SDK, and then follow the on-screen directions to download the SDK generated by API Gateway.

  6. Follow the instructions in Use a Ruby SDK Generated by API Gateway for a REST API to use the generated SDK.

Every time you update an API, you must redeploy the API and regenerate the SDK to have the updates included.