本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
API Gateway 中的 WebSocket API 概觀
在 API Gateway 中,您可以建立 WebSocket API 做為 AWS 服務 (例如 Lambda 或 DynamoDB) 或 HTTP 端點的可設定狀態前端。 WebSocket API 會根據從用戶端應用程式收到的訊息內容叫用後端。
與接收和回應請求的 REST API 不同, WebSocket API 支援用戶端應用程式與後端之間的雙向通訊。該後端可以將回呼訊息傳送到連線用戶端。
在您的 WebSocket API 中,傳入的 JSON 訊息會根據您設定的路由導向至後端整合。(會將非 JSON 訊息導向您設定的 $default
路由。)
路由包含的路由金鑰,是您可以在路由選擇表達式經評估後即預期的值。routeSelectionExpression
是在 API 層級定義的屬性。它指定的 JSON 屬性預計會出現在訊息承載。如需路由選擇表達式的詳細資訊,請參閱路由選擇表達式。
例如,如果您的 JSON 訊息包含 action
屬性,以及您想要根據此屬性執行不同動作,路由選擇表達式可能會 ${request.body.action}
。您的路由表將指定要執行哪一個動作,方法是將 action
屬性值與您在資料表中定義的自訂路由鍵值進行比對。
有三種預先定義的路由可供使用:$connect
、$disconnect
和 $default
。此外,您可以建立自訂路由。
-
當用戶端與 API 之間的持續連
$connect
線正在起始時, WebSocket API Gateway 會呼叫路由。 -
當用戶端或伺服器中斷與 API 的連線時,API Gateway 會呼叫
$disconnect
路由。 -
若發現相符的路由,針對該訊息評估路由選擇運算式後,API Gateway 即會呼叫自訂路由;該比對會判斷要叫用哪些整合。
-
如果未發現相符路由,或無法針對該訊息來評估路由選擇表達式時,API Gateway 會呼叫
$default
路由。
如需 $connect
和 $disconnect
路由的相關資訊,請參閱管理連線使用者和用戶端應用程式:$connect和$disconnect路由。
如需 $default
路由和自訂路由的相關資訊,請參閱調用後端集成:$default路由和自定義路由。
後端服務可將資料傳送到連線的用戶端應用程式。如需詳細資訊,請參閱 將資料從後端服務傳送至連線的用戶端。