Amazon API Gateway
開発者ガイド

API の Java SDK の生成

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

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

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

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

  4. [SDK の生成] タブの [プラットフォーム] で [Java] を選択し、次の操作を実行します。

    1. [サービス名] で、SDK の名前を指定しますたとえば、SimpleCalcSdk と指定します。これは、SDK クライアントクラスの名前になります。この名前は、SDK のプロジェクトフォルダの pom.xml ファイルで、<name> の下にある <project> タグに対応します。ハイフンは含めないでください。

    2. [Java Package Name (Java パッケージ名)] で、SDK のパッケージ名を指定しますたとえば、examples.aws.apig.simpleCalc.sdk と指定します。このパッケージ名は SDK ライブラリの名前空間として使用されます。ハイフンは含めないでください。

    3. [Java Build System (Java ビルドシステム)] で「maven」または「gradle」と入力してビルドシステムを指定します。

    4. [Java Group Id (Java グループ ID)] で、SDK プロジェクトのグループ ID を入力しますたとえば、my-apig-api-examples と指定します。この ID は、SDK のプロジェクトフォルダーの <groupId> ファイルで、<project> の下にある pom.xml タグに対応します。

    5. [Java Artifact Id (Java アーティファクト ID)] で、SDK プロジェクトのアーティファクト ID を入力しますたとえば、simple-calc-sdk と指定します。この ID は、SDK のプロジェクトフォルダーの <artifactId> ファイルで、<project> の下にある pom.xml タグに対応します。

    6. [Java Artifact Version (Java アーティファクトバージョン)] で、バージョン ID の文字列を入力しますたとえば、1.0.0 と指定します。このバージョン ID は、SDK のプロジェクトフォルダーの <version> ファイルで、<project> の下にある pom.xml タグに対応します。

    7. [Source Code License Text (ソースコードライセンステキスト)] に、ソースコードのライセンステキスト (ある場合) を入力します。

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

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

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