wscat を使用した WebSocket API への接続とメッセージの送信 - Amazon API Gateway

wscat を使用した WebSocket API への接続とメッセージの送信

この wscat ユーティリティは、API Gateway で作成してデプロイした WebSocket API をテストするための便利なツールです。wscat は以下のようにインストールして使用できます。

  1. https://www.npmjs.com/package/wscat から wscat をダウンロードします。

  2. 次のコマンドを実行して wscat をインストールします。

    npm install -g wscat
  3. API に接続するには、次の例のように wscat コマンドを実行します。この例では、Authorization 設定が NONE であることを前提としています。

    wscat -c wss://aabbccddee.execute-api.us-east-1.amazonaws.com/test/

    aabbccddee を実際の API ID を置き換える必要があります。これは API Gateway コンソールに表示されるか、AWS CLI create-api コマンドで返されます。

    さらに、API が us-east-1 以外のリージョンにある場合、正しいリージョンに置き換える必要があります。

  4. API をテストするには、接続中に次のようなメッセージを入力します。

    {"{jsonpath-expression}":"{route-key}"}

    ここで、{jsonpath-expression} は JSONPath 式で、{route-key} は API のルートキーです。例:

    {"action":"action1"} {"message":"test response body"}

    JSONPath の詳細については、JSONPath または JSONPath for Java を参照してください。

  5. API から切断するには、「ctrl-C」と入力します。