Generate the Ruby SDK of an API
To generate the Ruby SDK of an API in API Gateway
Sign in to the API Gateway console at https://console.amazonaws.cn/apigateway
. Choose a REST API.
-
Choose Stages.
-
In the Stages pane, select the name of the stage.
-
Open the Stage actions menu, and then choose Generate SDK.
-
For Platform, choose the Ruby platform and do the following:
-
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. -
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
. -
For Ruby Gem Version, specify a version number for the generated Ruby Gem. By default, it is set to
1.0.0
.
-
-
Choose Generate SDK, and then follow the on-screen directions to download the SDK generated by API Gateway.
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.