API Gateway에서 WebSocket API에 대한 라우팅 생성

WebSocket API에서 수신되는 JSON 메시지는 사용자가 구성한 라우팅을 기반으로 백엔드 통합으로 전달됩니다. (비 JSON 메시지는 사용자가 구성한 $default 라우팅으로 전달됩니다.)

라우팅에는 라우팅 선택 표현식을 평가할 경우 예상되는 값인 라우팅 키가 포함되어 있습니다. routeSelectionExpression은 API 수준에서 정의되는 속성입니다. 메시지 페이로드에 존재할 것으로 예상되는 JSON 속성을 지정합니다. 라우팅 선택 표현식에 대한 자세한 내용은 라우팅 선택 표현식 단원을 참조하십시오.

예를 들어 JSON 메시지에 action 속성이 있고 이 속성을 기반으로 다른 작업을 수행하려는 경우, 라우팅 선택 표현식은 ${request.body.action}일 수 있습니다. 라우팅 테이블은 사용자가 테이블에 정의한 사용자 지정 라우팅 키 값에 따라 action 속성 값을 일치시켜 어떤 작업을 수행할 것인지 지정할 것입니다.

$connect, $disconnect, $default 등 세 가지 사전 정의된 라우팅을 사용할 수 있습니다. 또한 사용자 지정 라우팅을 생성할 수 있습니다.

라우팅 선택 표현식

서비스가 수신 메시지에 대해 따라야 할 라우팅을 선택할 때 라우팅 선택 표현식이 평가됩니다. 서비스는 routeKey가 평가된 값과 정확하게 일치하는 라우팅을 사용합니다. 일치하는 값이 없고 라우팅 키가 $default인 라우팅이 존재하는 경우, 그 값이 선택됩니다. 평가된 값과 일치하는 라우팅이 없고 $default 라우팅이 없는 경우 서비스는 오류를 반환합니다. WebSocket 기반 API의 경우 표현식은 $request.body.{path_to_body_element} 형식이어야 합니다.

예를 들어 다음과 같은 JSON 메시지를 보낸다고 가정하겠습니다.

{
    "service" : "chat",
    "action" : "join",
    "data" : {
        "room" : "room1234"
   }
}

action 속성을 기반으로 API의 동작을 선택할 수 있습니다. 이 경우 다음 라우팅 선택 표현식을 정의할 수 있습니다.

$request.body.action

이 예에서 request.body는 메시지의 JSON 페이로드를 나타내며 .action은 JSONPath 표현식입니다. request.body 뒤에 모든 JSON 경로 표현식을 사용할 수 있지만 결과는 문자열로 변환됩니다. 예를 들어, JSONPath 표현식이 두 요소의 배열을 반환하면 "[item1, item2]" 문자열로 표시됩니다. 따라서 표현식을 배열이나 객체가 아닌 값으로 평가하는 것이 좋습니다.

단순히 정적 값을 사용하거나 여러 변수를 사용할 수 있습니다. 다음 표는 이전의 페이로드에 대한 예제와 평가된 결과를 보여줍니다.

평가된 결과는 라우팅을 찾는 데 사용됩니다. 일치하는 라우팅 키를 가진 라우팅이 있는 경우, 해당 라우팅이 선택되어 메시지를 처리합니다. 일치하는 라우팅이 없으면 API Gateway가 사용 가능한 $default 라우팅을 찾습니다. $default 라우팅이 정의되지 않은 경우, API Gateway는 오류를 반환합니다.

API Gateway에서 WebSocket API에 대한 라우팅 설정

처음 새 WebSocket API를 생성할 때 $connect, $disconnect, $default 등 세 가지 사전 정의된 라우팅이 있습니다. 콘솔, API 또는 AWS CLI를 사용하여 생성할 수 있습니다. 필요에 따라 사용자 지정 라우팅을 생성할 수 있습니다. 자세한 내용은 API Gateway의 WebSocket API 개요 단원을 참조하세요.

API Gateway 콘솔을 사용하여 라우팅 생성

AWS CLI를 사용하여 라우팅 생성

AWS CLI를 사용하여 라우팅을 생성하려면 다음 예와 같이 create-route를 호출합니다.

aws apigatewayv2 --region us-east-1 create-route --api-id aabbccddee --route-key $default

출력 예:

{
    "ApiKeyRequired": false,
    "AuthorizationType": "NONE",
    "RouteKey": "$default",
    "RouteId": "1122334"
}

$connect에 대한 라우팅 요청 설정 지정

API에 대해 $connect 라우팅을 설정하면 다음 선택적 설정을 사용하여 API에 대한 권한 부여를 활성화할 수 있습니다. 자세한 내용은 $connect 라우팅 단원을 참조하세요.

API Gateway 콘솔을 사용하여 $connect 라우팅 요청 설정

API Gateway 콘솔을 사용하여 WebSocket API에 대한 $connect 라우팅 요청을 설정하려면 다음을 수행하세요.