API Gateway で API の Ruby SDK を生成する - Amazon API Gateway

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

次の手順は、API Gateway で API の Ruby SDK を生成する方法を示しています。

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

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

  2. REST API を選択します。

  3. [ステージ] を選択します。

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

  5. [ステージアクション] メニューを開き、[SDK を生成] を選択します。

  6. [プラットフォーム] で 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 に設定されます。

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

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

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