メニュー
Amazon API Gateway
開発者ガイド

API の SDK を生成する

プラットフォームおよび言語に固有な方法で API を呼び出すには、プラットフォームおよび言語に固有な SDK を API 用に生成する必要があります。現在、API Gateway で API の SDK を生成するプラットフォームおよび言語としてサポートされているのは、Java、JavaScript、Java for Android、Objective-C、Swift for iOS です。

このセクションでは、API Gateway API の SDK を生成する方法と、生成された SDK を Java、JavaScript、Java for Android、Objective-C、Swift for iOS の各アプリで使用する方法について説明します。

わかりやすく説明するために、単純な電卓の Lambda 関数を公開する API Gateway API を例として使います。

先に進む前に、最低 1 回は API Gateway で API を作成またはインポートしてデプロイしてください。手順については、「API のデプロイ」を参照してください。

API Gateway コンソールを使用して API 用の SDKを生成する

API Gateway でプラットフォーム固有または言語固有の SDK を API 用に生成するには、最初に API の作成、テスト、ステージへのデプロイを行う必要があります。わかりやすいように、このセクションでは例として単純な電卓を使用し、言語固有またはプラットフォーム固有の SDK を生成します。この API を作成、テスト、デプロイする方法の手順については、「単純な電卓の API を作成する」を参照してください。

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

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

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

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

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

    1. [Java] で以下を指定します。

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

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

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

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

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

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

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

    2. [Android] で以下を指定します。

      • [Group ID] に、対応するプロジェクトの固有 ID を入力します。これは、pom.xml ファイルで使用されます (例: com.mycompany)。

      • [Invoker package] に、生成されたクライアントクラスの名前空間を入力します (例: com.mycompany.clientsdk)。

      • [Artifact ID] に、コンパイルされた .jar ファイルの名前を、バージョンを除外して入力します。これは、pom.xml ファイルで使用されます (例: aws-apigateway-api-sdk)。

      • [Artifact version] に、生成されたクライアントのアーティファクト版の番号を入力します。これは、pom.xml ファイルで使用され、「メジャー マイナー.パッチ」の形式である必要があります (例: 1.0.0)。

    3. [iOS (Objective-C)] または [iOS (Swift)] で、[Prefix] ボックスに一意のプレフィックスを入力します。プレフィックスの効果は次のとおりです。InputOutputResult をモデルとする SimpleCalc API の SDK にプレフィックスとして、たとえば SIMPLE_CALC を割り当てた場合、生成される SDK には、メソッドのリクエスト/レスポンスを含む API をカプセル化する SIMPLE_CALCSimpleCalcClient クラスが含まれます。さらに、生成される SDK には、リクエスト入力およびレスポンス出力の入力、出力、結果をそれぞれ表す SIMPLE_CALCInput クラス、SIMPLE_CALCOutput クラス、SIMPLE_CALCResult クラスが含まれます。詳細については、「Objective-C または Swift の API Gateway で生成された iOS SDK を使用する」を参照してください。

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

  6. 次のいずれかを行ってください。

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

次に、生成された SDK を使用して基盤となる API を呼び出す方法を示します。具体的に説明するために、次の API とその SDK を例として使います。