使用 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/

    您需要使用實際 API ID 取代 aabbccddee,該 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適用於 Java 的 JSONPath

  5. 若要中斷與 API 的連線,請輸入 ctrl-C