AWSツールキットを使って API Gateway の使用 - AWS Cloud9

AWSツールキットを使って API Gateway の使用

API Gateway を使用すると、リアルタイムの双方向通信アプリケーションを有効にする RESTful API と WebSocket API を作成できます。API Gateway を使用した API の作成と管理の詳細については、API Gateway デベロッパーガイド参照。

AWSツールキットを使って、REST リソース、メソッドタイプ、および入力として渡されるデータを指定して、REST API の呼び出しを設定できます。

API Gateway で REST API の呼び出し

重要

AWSツールキットを使用して API メソッドを呼び出すと、リソースが変更され、取り消すことができなくなる場合があります。たとえば、POSTメソッドを呼び出すと、呼び出しが成功すれば API のリソースが更新されます。

AWS上のAPI Gateway はAWSツールキットから呼び出すことができます。

REST API を呼び出すには

  1. [AWSExplorer] ウィンドウで、API Gateway ノードを選択して、現在のAWSリージョンで利用できる REST API のリストを表示します。

  2. REST API を右クリックし、AWSで呼び出しを選択します。

    注記

    コンテキストメニューでは、REST API の URL、名前、Amazon リソースネーム (ARN)のコピーもできます。

    -[メソッドの呼び出し] ウィンドウが表示され、API の呼び出しを設定できます。

  3. リソースの選択の場合、操作したい REST リソースを選択します。

  4. メソッドの選択の場合、次のいずれかのメソッドタイプを選択します。

    • GET: API を通じてアクセスされるバックエンドサービスからリソースを取得します。

    • オプション: API Gateway でサポートされているメソッドとオペレーションに関する情報を要求します。

    • POST: API を通じてアクセスされるバックエンドサービス上に新しいリソースを作成します。

  5. API メソッド呼び出しに入力を提供するには、クエリ文字列または JSON 形式のペイロードを使用します。

    • クエリ文字列: 形式parameter1=value1&parameter2=value2を使用してクエリ文字列を入力します。(クエリ文字列を使用する前に、マッピングテンプレートを作成して、統合バックエンドに送信される前に受信ウェブリクエストを変換します)。

    • JSON 形式:  呼び出し方法ウィンドウのラージテキストフィールドで JSON 形式のペイロードを定義できます。

      たとえば、次のペイロードを含むPOSTメソッドを使って、新しいリソースを追加できます。

      {"type": "soda", "price" : 3.99}
  6. [呼び出し] ボタンを選択して、REST API リソースを呼び出してください。

    REST API レスポンスは [AWSリモート呼び出し] タブをクリックします。レスポンス本文には、JSON 形式のリソースデータが含まれます。