本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。
設定 WebSocket API 的資料對應
資料映射可讓您將路由請求中的資料映射至後端整合。
注意
中不支援 WebSocket API 的資料對應 AWS Management Console。您必須使用 AWS CLI AWS CloudFormation、或 SDK 來配置資料對應。
將路由請求資料對應到整合請求參數
整合請求參數可以從任何定義的路由請求參數，請求內文、context 或 stage 的變量，以及靜態值進行映射。
在下表中，PARAM_NAME'^[a-zA-Z0-9._$-]+$]'。JSONPath_EXPRESSION 是請求內文的 JSON 欄位的 JSONPath 表達式。
整合請求資料對應表達式 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 對應的資料來源 | 對應表達式 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
請求查詢字串 (僅支援 $connect 路由) |
route.request.querystring. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
請求標頭 (僅支援 $connect 路由) |
route.request.header. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
多值請求查詢字串 (僅支援 $connect 路由) |
route.request.multivaluequerystring. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
多值請求標頭 (僅支援 $connect 路由) |
route.request.multivalueheader. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 請求內文 | route.request.body. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 階段變數 | stageVariables. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 環境變數 | context. 必須是支援的環境變數之一。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 靜態值 | STATIC_VALUE 是字串常值，而且必須以一對單引號括住。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
範例
下列 AWS CLI 範例設定資料對映。如需範例 AWS CloudFormation 範本，請參閱websocket-data-mapping.yaml。
將用戶端的連線 ID 映射至整合請求中的標頭
下列範例命令會將用戶端的 connectionId 映射至後端整合請求中的 connectionId 標頭。
aws apigatewayv2 update-integration \ --integration-id abc123 \ --api-id a1b2c3d4 \ --request-parameters 'integration.request.header.connectionId'='context.connectionId'
將查詢字串參數映射至整合請求中的標頭
下列範例命令會將 authToken 查詢字串參數映射至整合請求中的 authToken 標頭。
首先，將 authToken 查詢字符串參數新增到路由的請求參數。
aws apigatewayv2 update-route --route-id 0abcdef \ --api-id a1b2c3d4 \ --request-parameters '{"route.request.querystring.authToken": {"Required": false}}'
接下來，將查詢字串參數映射至請求中的 authToken 標頭到後端整合。
aws apigatewayv2 update-integration \ --integration-id abc123 \ --api-id a1b2c3d4 \ --request-parameters 'integration.request.header.authToken'='route.request.querystring.authToken'
如有必要，請從路由的請求參數中刪除 authToken 查詢字串參數。
aws apigatewayv2 delete-route-request-parameter \ --route-id 0abcdef \ --api-id a1b2c3d4 \ --request-parameter-key 'route.request.querystring.authToken'
