API Gateway에서 WebSocket API 배포

WebSocket API를 생성한 후, 사용자가 호출할 수 있도록 배포해야 합니다.

API를 배포하려면 API 배포를 생성해 단계에 연결합니다. 각 단계는 API의 스냅샷이며 클라이언트 앱이 호출할 수 있습니다.

배포된 WebSocket API를 호출하기 위해 클라이언트는 API의 URL로 메시지를 보냅니다. URL은 API의 호스트 이름과 스테이지 이름에 의해 결정됩니다.

API의 기본 도메인 이름을 사용하면 지정된 단계({stageName})의 WebSocket API URL은 다음 형식이 됩니다.

wss://{api-id}.execute-api.{region}.amazonaws.com/{stageName}

WebSocket API의 URL을 사용자에게 더욱 친숙하게 만들려면 사용자 지정 도메인 이름(예: api.example.com)을 생성하여 API의 기본 호스트 이름을 대체할 수 있습니다. 이 구성 프로세스는 REST API의 프로세스와 동일합니다. 자세한 내용은 API Gateway의 퍼블릭 REST API에 대한 사용자 지정 도메인 이름 단원을 참조하세요.

단계를 통해 API의 강력한 버전 관리가 가능합니다. 예를 들어 API를 test 단계와 prod 단계에 배포하고, test 단계를 테스트 빌드로, prod 단계를 안정적 빌드로 사용할 수 있습니다. 업데이트가 테스트를 통과한 후 test 단계를 prod 단계로 승격할 수 있습니다. 프로모션은 API를 prod 스테이지로 재배포하여 수행할 수 있습니다. 스테이지에 대한 자세한 내용은 API Gateway에서 REST API에 대한 스테이지 설정 단원을 참조하십시오 .

AWS CLI를 사용하여 WebSocket API 배포 생성

다음 create-deployment 명령을 사용하면 배포가 생성됩니다.

aws apigatewayv2 --region us-east-1 create-deployment --api-id aabbccddee

출력은 다음과 같습니다.

{
    "DeploymentId": "fedcba",
    "DeploymentStatus": "DEPLOYED",
    "CreatedDate": "2018-11-15T06:49:09Z"
}

배포를 스테이지에 연결할 때까지는 배포된 API를 호출할 수 없습니다. 새 스테이지를 만들거나 이전에 만든 스테이지를 재사용할 수 있습니다.

다음 create-stage 명령은 새 스테이지를 만들어 배포에 연결합니다.

aws apigatewayv2 --region us-east-1 create-stage --api-id aabbccddee --deployment-id fedcba --stage-name test

출력은 다음과 같습니다.

{
    "StageName": "test",
    "CreatedDate": "2018-11-15T06:50:28Z",
    "DeploymentId": "fedcba",
    "DefaultRouteSettings": {
        "MetricsEnabled": false,
        "ThrottlingBurstLimit": 5000,
        "DataTraceEnabled": false,
        "ThrottlingRateLimit": 10000.0
    },
    "LastUpdatedDate": "2018-11-15T06:50:28Z",
    "StageVariables": {},
    "RouteSettings": {}
}

스테이지의 deploymentId 속성을 새로 생성된 배포 ID(deployment-id)로 업데이트하여 기존 스테이지를 재사용할 수도 있습니다. 다음 update-stage 명령은 스테이지의 배포 ID를 업데이트합니다.

aws apigatewayv2 update-stage --region region \
    --api-id api-id \ 
    --stage-name stage-name \ 
    --deployment-id deployment-id

API Gateway 콘솔을 사용하여 WebSocket API 배포 만들기

API Gateway 콘솔을 사용하여 WebSocket API에 대한 배포를 만들려면: