자습서: AWS 통합을 통해 WebSocket API 생성

AWS CloudFormation 스택을 생성하려면

1. AWS CloudFormation 콘솔(https://console.aws.amazon.com/cloudformation)을 엽니다.

2. 스택 생성을 선택한 다음 새 리소스 사용(표준)을 선택합니다.

3. 템플릿 지정에서 템플릿 파일 업로드를 선택합니다.

4. 다운로드한 템플릿을 선택합니다.

5. 다음을 선택합니다.

6. 스택 이름에 websocket-step-functions-tutorial을 입력하고 다음을 선택합니다.

7. 스택 옵션 구성에서 다음을 선택합니다.

8. 기능의 경우 AWS CloudFormation이 계정에 IAM 리소스를 생성할 수 있음을 확인합니다.

9. 제출을 선택합니다.

WebSocket API를 생성하려면

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. API 생성을 선택합니다. WebSocket API에서 빌드(Build)를 선택합니다.

3. API 이름에서 websocket-step-functions-tutorial을 입력합니다.

4. 경로 선택 표현식(Route selection expression)에 request.body.action을 입력합니다.

   경로 선택 표현식에 따라 클라이언트가 메시지를 보낼 때 API Gateway에서 호출할 경로가 결정됩니다.

5. Next(다음)를 선택합니다.

6. 미리 정의된 경로의 경우 $connect 추가, $disconnect 추가, $default 추가를 선택합니다.

   $connect 및 $disconnect 경로는 클라이언트가 API에 연결하거나 API에서 연결을 끊을 때 API Gateway가 자동으로 호출하는 특수 경로입니다. API Gateway는 요청과 일치하는 다른 경로가 없는 경우 $default 경로를 간접 호출합니다. API를 생성한 후 Step Functions에 연결할 사용자 지정 경로를 생성합니다.

7. Next(다음)를 선택합니다.

8. $connect를 위한 통합의 경우 다음을 수행합니다.

   1. 통합 유형‬에서 ‬Lambda를 선택합니다.

   2. Lambda 함수에서, 1단계에서 AWS CloudFormation으로 생성한 해당 $connect Lambda 함수를 선택합니다. Lambda 함수 이름은 websocket-step으로 시작해야 합니다.

9. $disconnect를 위한 통합의 경우 다음을 수행합니다.

   1. 통합 유형‬에서 ‬Lambda를 선택합니다.

   2. Lambda에서, 1단계에서 AWS CloudFormation으로 생성한 해당 $disconnect Lambda 함수를 선택합니다. Lambda 함수 이름은 websocket-step으로 시작해야 합니다.

10. $default를 위한 통합의 경우 모의을 선택합니다.

    모의 통합에서는 API Gateway가 통합 백엔드가 없어도 경로 응답을 관리합니다.

11. Next(다음)를 선택합니다.

12. API Gateway가 생성하는 스테이지를 검토합니다. 기본적으로 API Gateway는 스테이지 프로덕션이라는 스테이지를 생성하여 API를 해당 스테이지에 자동으로 배포합니다. Next(다음)를 선택합니다.

13. 생성 및 배포를 선택합니다.

Lambda 권한 부여자를 생성하려는 경우

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. 기본 탐색 창에서 권한 부여자를 선택합니다.

3. 권한 부여자 생성을 선택합니다.

4. 권한 부여자 이름에 LambdaAuthorizer를 입력합니다.

5. 권한 부여자 ARN의 경우 AWS CloudFormation 템플릿에서 생성한 권한 부여자의 이름을 입력합니다. websocket-step-functions-tutorial-AuthorizerHandler로 시작하는 이름은 사용할 수 없습니다.

   참고

   프로덕션 API에는 이 예제 권한 부여자를 사용하지 않는 것이 좋습니다.

6. ID 소스 유형에서는 헤더를 선택합니다. 키에 Authorization를 입력합니다.

7. 권한 부여자 생성을 선택합니다.

$connect 경로에 권한 부여자를 연결하려면

1. 기본 탐색 창에서 경로를 선택합니다.

2. $connect 경로를 선택합니다.

3. 경로 요청 설정 섹션에서 편집을 선택합니다.

4. 권한 부여의 경우 드롭다운 메뉴를 선택한 다음 요청 권한 부여자를 선택합니다.

5. 변경 사항 저장을 선택합니다.

모의 통합을 생성하는 방법

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. $default 경로를 선택한 다음 통합 요청 탭을 선택합니다.

3. 요청 템플릿의 경우 편집을 선택합니다.

4. 템플릿 선택 표현식에 200을 입력한 다음 편집을 선택합니다.

5. 통합 요청 탭의 요청 템플릿에서 템플릿 생성을 선택합니다.

6. 템플릿 키에 200를 입력합니다.

7. 템플릿 생성에 다음 매핑 템플릿을 입력합니다:

   {"statusCode": 200}

   템플릿 생성을 선택합니다.

   결과는 다음과 같아야 합니다.

   

8. $default 경로 창에서 양방향 통신 활성화를 선택합니다.

9. 통합 응답 탭을 선택한 다음 통합 응답 생성을 선택합니다.

10. 응답 본문에 $default를 입력합니다.

11. 템플릿 선택 표현식에 200을 입력합니다.

12. 응답 생성을 선택합니다.

13. 응답 템플릿에서 템플릿 생성을 선택합니다.

14. 템플릿 키에 200를 입력합니다.

15. 응답 템플릿에 다음 매핑 템플릿을 입력합니다.

    {"Use the sendmessage route to send a message. Connection ID: $context.connectionId"}

16. 템플릿 생성을 선택합니다.

    결과는 다음과 같아야 합니다.

    

비프록시 통합을 생성하려면

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. 경로 생성(Create route)을 선택합니다.

3. 경로 키(Route key)에 sendmessage를 입력합니다.

4. 통합 유형에서 AWS 서비스를 선택합니다.

5. AWS 리전에는 AWS CloudFormation 템플릿을 배포한 리전을 입력합니다.

6. AWS 서비스에서 Step Functions를 선택합니다.

7. HTTP 메서드에 대해 POST를 선택합니다.

8. 함수 이름에 StartExecution를 입력합니다.

9. 실행 역할에는 AWS CloudFormation 템플릿에서 생성한 실행 역할을 입력합니다. 이름은 WebsocketTutorialApiRole이어야 합니다.

10. 경로 생성(Create route)을 선택합니다.

매핑 템플릿을 생성하려면

1. sendmessage 경로를 선택한 다음 통합 요청 탭을 선택합니다.

2. 요청 템플릿 섹션에서 편집을 선택합니다.

3. 템플릿 선택 표현식에 \$default를 입력합니다.

4. 편집을 선택합니다.

5. 템플릿 요청 섹션에서 템플릿 생성을 선택합니다.

6. 템플릿 키에 \$default를 입력합니다.

7. 템플릿 생성에 다음 매핑 템플릿을 입력합니다.

   #set($domain = "$context.domainName")
   #set($stage = "$context.stage")
   #set($body = $input.json('$'))
   #set($getMessage = $util.parseJson($body))
   #set($mymessage = $getMessage.message)
   {
   "input": "{\"domain\": \"$domain\", \"stage\": \"$stage\", \"message\": \"$mymessage\"}",
   "stateMachineArn": "arn:aws:states:us-east-2:123456789012:stateMachine:WebSocket-Tutorial-StateMachine"
   }

   stateMachineArn을 AWS CloudFormation이 만든 스테이트 머신의 ARN으로 바꿉니다.

   매핑 템플릿이 다음을 수행합니다.

   • 컨텍스트 변수 domainName을 사용하여 변수 $domain을 생성합니다.

   • 컨텍스트 변수 stage를 사용하여 변수 $stage를 생성합니다.

     $domain 및 $stage 변수는 콜백 URL을 작성하는 데 필요합니다.

   • 수신되는 sendmessage JSON 메시지를 받아 message 속성을 추출합니다.

   • 상태 머신에 대한 입력을 생성합니다. 입력은 WebSocket API의 도메인 및 스테이지와 sendmessage 경로의 메시지입니다.

8. 템플릿 생성을 선택합니다.

   

API를 배포하려면

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. 기본 탐색 창에서 경로를 선택합니다.

3. Deploy API(API 배포)를 선택합니다.

4. 스테이지에서는 프로덕션을 선택합니다.

5. (선택 사항) 배포 설명에 설명을 입력합니다.

6. 배포를 선택합니다.

API의 URL 간접 호출을 가져오려면

1. API를 선택합니다.

2. 스테이지(Stages)를 선택한 다음 프로덕션(production)을 선택합니다.

3. API의 WebSocket URL을 기록해 둡니다. URL은 wss://abcdef123.execute-api.us-east-2.amazonaws.com/production와 같아야 합니다.

API에 대한 연결을 테스트하려면

1. API에 연결하려면 다음 명령을 사용합니다. 먼저 /ping 경로를 간접 호출하여 연결을 테스트합니다.

   wscat -c wss://abcdef123.execute-api.us-east-2.amazonaws.com/production -H "Authorization: Allow" --slash -P

   Connected (press CTRL+C to quit)

2. 다음 명령을 입력하여 컨트롤 프레임을 핑합니다. 클라이언트 측에서 keepalive 목적으로 컨트롤 프레임을 사용할 수 있습니다.

   /ping

   결과는 다음과 같아야 합니다.

   < Received pong (data: "")

API 테스트하기

1. 새 터미널을 열고 다음 파라미터를 사용하여 wscat 명령을 다시 실행합니다.

   wscat -c wss://abcdef123.execute-api.us-east-2.amazonaws.com/production -H "Authorization: Allow"

   Connected (press CTRL+C to quit)

2. API Gateway는 API의 경로 선택 표현식을 기반으로 간접 호출할 경로를 결정합니다. API의 경로 선택 표현식은 $request.body.action입니다. 따라서 API Gateway는 다음 메시지가 전송될 때 sendmessage 경로를 호출합니다.

   {"action": "sendmessage", "message": "hello, from Step Functions!"}

   경로와 연결된 Step Functions 상태 머신은 메시지 및 콜백 URL과 함께 Lambda 함수를 간접 호출합니다. Lambda 함수는 API Gateway Management API를 호출하고 모든 연결된 클라이언트에 메시지를 보냅니다. 모든 클라이언트는 다음과 같은 메시지를 받습니다.

   < hello, from Step Functions!

API 연결을 해제하려면

• API 연결을 해제하려면 CTRL+C를 누릅니다.

  클라이언트가 API에서 연결을 해제하면 API Gateway에서 API $disconnect의 경로를 간접 호출합니다. API의 $disconnect 경로에 대한 Lambda 통합이 DynamoDB에서 연결 ID를 제거합니다.

WebSocket API를 삭제하려면

1. https://console.aws.amazon.com/apigateway에서 API Gateway 콘솔에 로그인합니다.

2. APIs 페이지에서 websocket-api.를 선택합니다.

3. 작업(Actions)을 선택하고 삭제(Delete)를 선택한 다음 선택을 확인합니다.

AWS CloudFormation 스택을 삭제하려면

1. AWS CloudFormation 콘솔(https://console.aws.amazon.com/cloudformation)을 엽니다.

2. AWS CloudFormation 스택을 선택합니다.

3. 삭제를 선택한 다음 해당 선택을 확인합니다.