wscat
を使用した WebSocket API への接続とメッセージの送信
この wscat
ユーティリティは、API Gateway で作成してデプロイした WebSocket API をテストするための便利なツールです。wscat
は以下のようにインストールして使用できます。
-
https://www.npmjs.com/package/wscat
から wscat
をダウンロードします。 -
次のコマンドを実行して
wscat
をインストールします。npm install -g wscat
-
API に接続するには、次の例のように
wscat
コマンドを実行します。この例では、Authorization
設定がNONE
であることを前提としています。wscat -c wss://
aabbccddee
.execute-api.us-east-1
.amazonaws.com/test/
を実際の API ID に置き換える必要があります。これは API Gateway コンソールに表示されるか、AWS CLIaabbccddee
create-api
コマンドによって返されます。さらに、API が
us-east-1
以外のリージョンにある場合、正しいリージョンに置き換える必要があります。 -
API をテストするには、接続中に次のようなメッセージを入力します。
{"
{jsonpath-expression}
":"{route-key}
"}ここで、
{jsonpath-expression}
は JSONPath 式で、{route-key}
は API のルートキーです。例:{"action":"action1"} {"message":"test response body"}
JSONPath の詳細については、JSONPath
または JSONPath for Java を参照してください。 -
API から切断するには、「
ctrl-C
」と入力します。