AWS ドキュメント » Amazon API Gateway » 開発者ガイド » Amazon API Gateway での REST API の作成、デプロイ、および呼び出し » Amazon API Gateway での REST API のデプロイ » API Gateway で REST API の SDK を生成する » API Gateway コンソールを使用して API 用の SDKを生成する » API の Ruby SDK の生成

API の Ruby SDK の生成

API Gateway で API の Ruby SDK を生成するには

1. https://console.aws.amazon.com/apigateway で API Gateway コンソールにサインインします。

2. ステージの API 名を含むボックスで、[ステージ] を選択します。

3. [ステージ] ペインで、ステージの名前を選択します。

4. [SDK 生成] タブの [プラットフォーム] で、[Ruby] を選択します。

   1. [サービス名] で、SDK の名前を指定しますたとえば、SimpleCalc と指定します。これは、API の Ruby Gem の名前空間を生成するために使用されます。名前はすべて文字である必要があり (a-zA-Z)、その他の特殊文字や数字は使用できません。

   2. [Ruby Gem Name (Ruby Gem 名)] で、Ruby Gem の名前を指定し、API 用に生成された SDK ソースコードを含めます。デフォルトでは、小文字のサービス名に -sdk サフィックスを加えたものです (simplecalc-sdk など)。

   3. [Ruby Gem Version (Ruby Gem バージョン)] で、生成された Ruby Gem のバージョン番号を指定します。デフォルトでは、1.0.0 に設定されます。

5. [SDK の生成] を選択し、画面の指示に従って API Gateway で生成された SDK をダウンロードします。

6. 生成された SDK を使用するには、「REST API に対して API Gateway で生成された Ruby SDK を使用する」の手順に従います。

API を更新するたびに、更新を反映するために API を再デプロイして SDK を再生成する必要があります。