Amazon API Gateway WebSocket APIでリアルタイム通信を行うチャットAPを開発 [SAR/SAM]

  • リアルタイムの双方向通信を可能にするAmazon API Gateway WebSocket APIについてのメモ
    • 活用例: チャットアプリ、金融取引システム
  • リアルタイムの双方向通信にはAppSyncを活用する手もあるが、条件によっては使えないことがあった(個人的にはAmplifyでAppSyncを自動生成するのが一番楽だと思います)
  • 下記はAWSブログで公開されていたリアルタイムチャットAPの開発方法とGithubに公開されているSAMテンプレートの内容の個人的理解のまとめ

Amazon API Gateway WebSocket API

WebSocketAPIとは

  • Amazon API Gatewayには以下の3種のタイプがある

    • HTTP API
    • REST API
    • WebSocket API
  • WebSocket API

    • リアルタイムでの双方向通信に用いられるAPIタイプ
    • 公式説明
      1
      2
      チャットアプリケーションやダッシュボードなど、リアルタイムのユースケース向けの永続的な接続を使用する WebSocket API を構築します。
      双方向の振る舞いにより、クライアント/サーバーとのやりとりがより豊富になります。これは、明示的なリクエストをする必要のないクライアントにデータをプッシュできるためです。 WebSocket APIは、チャットアプリケーション、コラボレーションプラットフォーム、マルチプレイヤーゲーム、金融取引プラットフォームなどのリアルタイムアプリケーションでよく使用されます。
  • 従来WebSocket APIを構築するためには、WebSocketプロトコルの基礎となる永続的な接続の管理を担当するホストの設定が必要であったが、API Gateway Web Socket APIであれば、こういった作業をショートカットできる

WebSocket APIの概念

  • ルート
    • 新しいリソースタイプ
      1
      ルートは、API Gatewayが特定のタイプのクライアントリクエストを処理する方法を記述し、ルートを識別するために提供する値であるrouteKeyパラメータを含みます。
    • WebSocket APIは1つまたは複数のルートで構成される
      1
      WebSocket APIは、1つまたは複数のルートで構成されています。特定のインバウンドリクエストで使用するルートを決定するには、ルートセレクションエクスプレッション(選択式)を指定します。式は、ルートのrouteKey値の1つに対応する値を生成する着信リクエストに対して評価されます。
  • API Gatewayでルートに使用できる3つの特別なrouteKey値
    • $default
      1
      選択式がAPIルート内の他のrouteKeyに一致しない値を生成する場合に使用されます。 これは、例えば、一般的なエラー処理メカニズムを実装するために使用できます。
    • $connect
      1
      クライアントがWebSocket APIに最初に接続するときに、関連するルートが使用されます。
    • $disconnect
      1
      クライアントがAPIから切断すると、関連するルートが使用されます。 この呼び出しは、ベストエフォート方式で行われます。

構築手順

開発サンプル:リアルタイムチャットAP

WebSocket Chat App Architecture

  • WebSocket APIとAPI Gatewayを使用してサーバーレスのリアルタイムチャットAPを構築する

  • 主な機能

    • クライアントはWebSocket APIに接続するときにチャットルームに参加
    • バックエンドは、ユーザーがWebSocket APIに接続した後に提供されるコールバックURLを使用して、特定のユーザーにメッセージを送信できる
    • ユーザーはルームにメッセージを送信できる
    • 切断されたクライアントはチャットルームから削除される
  • ロジック概要

    1
    アプリケーションは、クライアントとサーバー(1)間の接続を処理するAPI GatewayのWebSocket APIで構成されています。 クライアントがAPIに接続(2)または切断(5)すると、2つのAWS Lambdaが反応します。 sendMessage関数(3)は、クライアントがサーバーにメッセージを送信するときに呼び出されます。 サーバーは、新しいAPI Gateway管理APIを使用して、接続されているすべてのクライアント(4)にメッセージを送信します。 接続された各クライアントを追跡するには、DynamoDBテーブルを使用して接続識別子を保持します。
  • 構築方法は3つあったので全て試した

    • 手動でAWS Consoleから構築
    • AWS Serverless Application Repository(SAR)のsimple websocket-chat-appを実行
      • SARであればボタン一つで自動構築できる。SAMのテンプレートがAP単位で公開されている
      • 今回のチャットAPの一式(Lambda関数、DynamoDBテーブル定義、IAMロールなど)が提供されている
    • SAM(Serverless Application Model)テンプレートをSAM CLIで実行
      • GitHubリポジトリにSARで使われているテンプレートが公開されている
      • 上記のリポジトリを手元にCloneしてSAM CLIで実行する
  • AmplifyではWebSocket APIはまだ使えないっぽい(2021/08/20時点)

SAMテンプレート

  • SAM CLIを用いると以下のテンプレートで環境を自動生成できる

    • オリジナルのWebSocket APIを開発する際もここから改変すると楽そう
    • ParameterはDynamoDBのテーブル名のみ
    • 内容の説明は以降のコンソールでの実装手順と一緒にまとめた
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
      57
      58
      59
      60
      61
      62
      63
      64
      65
      66
      67
      68
      69
      70
      71
      72
      73
      74
      75
      76
      77
      78
      79
      80
      81
      82
      83
      84
      85
      86
      87
      88
      89
      90
      91
      92
      93
      94
      95
      96
      97
      98
      99
      100
      101
      102
      103
      104
      105
      106
      107
      108
      109
      110
      111
      112
      113
      114
      115
      116
      117
      118
      119
      120
      121
      122
      123
      124
      125
      126
      127
      128
      129
      130
      131
      132
      133
      134
      135
      136
      137
      138
      139
      140
      141
      142
      143
      144
      145
      146
      147
      148
      149
      150
      151
      152
      153
      154
      155
      156
      157
      158
      159
      160
      161
      162
      163
      164
      165
      166
      167
      168
      169
      170
      171
      172
      173
      174
      175
      176
      177
      178
      179
      180
      181
      182
      183
      184
      185
      186
      187
      188
      189
      190
      191
      192
      193
      194
      195
      196
      197
      198
      199
      200
      201
      202
      203
      AWSTemplateFormatVersion: '2010-09-09'
      Transform: AWS::Serverless-2016-10-31
      Description: >
      simple-websockets-chat-app
      SAM Template for simple-websockets-chat-app that has the DynamoDB table and Lambda
      functions needed to demonstrate the Websocket protocol on API Gateway.
      Parameters:
      TableName:
      Type: String
      Default: 'simplechat_connections'
      Description: (Required) The name of the new DynamoDB to store connection identifiers for each connected clients. Minimum 3 characters
      MinLength: 3
      MaxLength: 50
      AllowedPattern: ^[A-Za-z_]+$
      ConstraintDescription: 'Required. Can be characters and underscore only. No numbers or special characters allowed.'

      Resources:
      SimpleChatWebSocket:
      Type: AWS::ApiGatewayV2::Api
      Properties:
      Name: SimpleChatWebSocket
      ProtocolType: WEBSOCKET
      RouteSelectionExpression: "$request.body.action"
      ConnectRoute:
      Type: AWS::ApiGatewayV2::Route
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      RouteKey: $connect
      AuthorizationType: NONE
      OperationName: ConnectRoute
      Target: !Join
      - '/'
      - - 'integrations'
      - !Ref ConnectInteg
      ConnectInteg:
      Type: AWS::ApiGatewayV2::Integration
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      Description: Connect Integration
      IntegrationType: AWS_PROXY
      IntegrationUri:
      Fn::Sub:
      arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OnConnectFunction.Arn}/invocations
      DisconnectRoute:
      Type: AWS::ApiGatewayV2::Route
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      RouteKey: $disconnect
      AuthorizationType: NONE
      OperationName: DisconnectRoute
      Target: !Join
      - '/'
      - - 'integrations'
      - !Ref DisconnectInteg
      DisconnectInteg:
      Type: AWS::ApiGatewayV2::Integration
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      Description: Disconnect Integration
      IntegrationType: AWS_PROXY
      IntegrationUri:
      Fn::Sub:
      arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OnDisconnectFunction.Arn}/invocations
      SendRoute:
      Type: AWS::ApiGatewayV2::Route
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      RouteKey: sendmessage
      AuthorizationType: NONE
      OperationName: SendRoute
      Target: !Join
      - '/'
      - - 'integrations'
      - !Ref SendInteg
      SendInteg:
      Type: AWS::ApiGatewayV2::Integration
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      Description: Send Integration
      IntegrationType: AWS_PROXY
      IntegrationUri:
      Fn::Sub:
      arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${SendMessageFunction.Arn}/invocations
      Deployment:
      Type: AWS::ApiGatewayV2::Deployment
      DependsOn:
      - ConnectRoute
      - SendRoute
      - DisconnectRoute
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      Stage:
      Type: AWS::ApiGatewayV2::Stage
      Properties:
      StageName: Prod
      Description: Prod Stage
      DeploymentId: !Ref Deployment
      ApiId: !Ref SimpleChatWebSocket
      ConnectionsTable:
      Type: AWS::DynamoDB::Table
      Properties:
      AttributeDefinitions:
      - AttributeName: "connectionId"
      AttributeType: "S"
      KeySchema:
      - AttributeName: "connectionId"
      KeyType: "HASH"
      ProvisionedThroughput:
      ReadCapacityUnits: 5
      WriteCapacityUnits: 5
      SSESpecification:
      SSEEnabled: True
      TableName: !Ref TableName
      OnConnectFunction:
      Type: AWS::Serverless::Function
      Properties:
      CodeUri: onconnect/
      Handler: app.handler
      MemorySize: 256
      Runtime: nodejs12.x
      Environment:
      Variables:
      TABLE_NAME: !Ref TableName
      Policies:
      - DynamoDBCrudPolicy:
      TableName: !Ref TableName
      OnConnectPermission:
      Type: AWS::Lambda::Permission
      DependsOn:
      - SimpleChatWebSocket
      Properties:
      Action: lambda:InvokeFunction
      FunctionName: !Ref OnConnectFunction
      Principal: apigateway.amazonaws.com
      OnDisconnectFunction:
      Type: AWS::Serverless::Function
      Properties:
      CodeUri: ondisconnect/
      Handler: app.handler
      MemorySize: 256
      Runtime: nodejs12.x
      Environment:
      Variables:
      TABLE_NAME: !Ref TableName
      Policies:
      - DynamoDBCrudPolicy:
      TableName: !Ref TableName
      OnDisconnectPermission:
      Type: AWS::Lambda::Permission
      DependsOn:
      - SimpleChatWebSocket
      Properties:
      Action: lambda:InvokeFunction
      FunctionName: !Ref OnDisconnectFunction
      Principal: apigateway.amazonaws.com
      SendMessageFunction:
      Type: AWS::Serverless::Function
      Properties:
      CodeUri: sendmessage/
      Handler: app.handler
      MemorySize: 256
      Runtime: nodejs12.x
      Environment:
      Variables:
      TABLE_NAME: !Ref TableName
      Policies:
      - DynamoDBCrudPolicy:
      TableName: !Ref TableName
      - Statement:
      - Effect: Allow
      Action:
      - 'execute-api:ManageConnections'
      Resource:
      - !Sub 'arn:aws:execute-api:${AWS::Region}:${AWS::AccountId}:${SimpleChatWebSocket}/*'
      SendMessagePermission:
      Type: AWS::Lambda::Permission
      DependsOn:
      - SimpleChatWebSocket
      Properties:
      Action: lambda:InvokeFunction
      FunctionName: !Ref SendMessageFunction
      Principal: apigateway.amazonaws.com

      Outputs:
      ConnectionsTableArn:
      Description: "Connections table ARN"
      Value: !GetAtt ConnectionsTable.Arn

      OnConnectFunctionArn:
      Description: "OnConnect function ARN"
      Value: !GetAtt OnConnectFunction.Arn

      OnDisconnectFunctionArn:
      Description: "OnDisconnect function ARN"
      Value: !GetAtt OnDisconnectFunction.Arn

      SendMessageFunctionArn:
      Description: "SendMessage function ARN"
      Value: !GetAtt SendMessageFunction.Arn

      WebSocketURI:
      Description: "The WSS Protocol URI to connect to"
      Value: !Join [ '', [ 'wss://', !Ref SimpleChatWebSocket, '.execute-api.',!Ref 'AWS::Region','.amazonaws.com/',!Ref 'Stage'] ]
  • Resourceのまとめ

    • AWS::ApiGatewayV2::Api x 1
    • RouteとIntegration x 3セット
      • AWS::ApiGatewayV2::Route x 3
      • AWS::ApiGatewayV2::Integration x 3
    • デプロイ関係
      • AWS::ApiGatewayV2::Deployment x 1
      • AWS::ApiGatewayV2::Stage
    • AWS::DynamoDB::Table x 1
    • Lambda関数と権限 x 3セット
      • AWS::Serverless::Function x3
      • AWS::Lambda::Permission x 3

WebSocket APIの作成(コンソールからの構築手順)

コンソールでポチポチする場合は先にLambda関数を作ったほうが手間が少ない
コンソールでの構築手順とテンプレートの該当箇所を以下に示す

  • AWS Console/API Gateway/APIを作成

  • APIタイプを選択

    • WebSocketAPIの”構築”を押下
  • Step1 APIの詳細を指定する

    • API名
      • ex. My Chat API
    • ルート選択式
      • ex. $ request.body.action
      • ルート選択式の値で記述された属性は、クライアントがAPIに送信するすべてのメッセージに存在する必要がある。リクエストメッセージの例↓
        1
        2
        3
        4
        {
        "action": "sendmessage",
        “data”: "Hello, I am using WebSocket APIs in API Gateway.”
        }
      • WebSocket APIは、メッセージの内容に基づいてメッセージをルーティングするために、ルーティングキーとして機能するJSON形式のメッセージを必要とする
    • 次へ
  • Step1の設定内容はSAMテンプレートの以下に該当する

    1
    2
    3
    4
    5
    6
    SimpleChatWebSocket:
    Type: AWS::ApiGatewayV2::Api
    Properties:
    Name: SimpleChatWebSocket
    ProtocolType: WEBSOCKET
    RouteSelectionExpression: "$request.body.action"
  • Step2 ルートを追加

    • $connectや$disconnectなどは事前定義されている
    • カスタムルート
      • “カスタムルートを追加”
        • こちらから独自のルートを作成する
      • ルートキーを入力
        • ex: sendmessage
    • 次へ
  • Step3 統合をアタッチする

    • 公式説明
      1
      この API をデプロイするには、少なくとも 1 つのルートを設定する必要があります。設定するすべてのルートに統合がアタッチされている必要があります。後で統合をセットアップするには、ルートの統合タイプとして [Mock] を選択します。
    • 統合タイプ
      • 以下がある
        • Mock, Lambda, HTTP, AWSのサービス VPCリンク
      • 今回はLambda
        • 既存のLambdaを選択
        • 先に作成しておく必要がある
      • Mock
        • 後で統合する場合はMockを選択
    • 次へ
  • Step2,3の設定事項(Route/Integration)はSAMの以下に該当する

    • RouteとIntegarationはセット(今回は3セット)
    • IntegrationでLambdaとの紐づけを行っている
      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      27
      28
      29
      30
      31
      32
      33
      34
      35
      36
      37
      38
      39
      40
      41
      42
      43
      44
      45
      46
      47
      48
      49
      50
      51
      52
      53
      54
      55
      56
      57
      58
      59
      60
      ConnectRoute:
      Type: AWS::ApiGatewayV2::Route
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      RouteKey: $connect
      AuthorizationType: NONE
      OperationName: ConnectRoute
      Target: !Join
      - '/'
      - - 'integrations'
      - !Ref ConnectInteg
      ConnectInteg:
      Type: AWS::ApiGatewayV2::Integration
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      Description: Connect Integration
      IntegrationType: AWS_PROXY
      IntegrationUri:
      Fn::Sub:
      arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OnConnectFunction.Arn}/invocations
      DisconnectRoute:
      Type: AWS::ApiGatewayV2::Route
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      RouteKey: $disconnect
      AuthorizationType: NONE
      OperationName: DisconnectRoute
      Target: !Join
      - '/'
      - - 'integrations'
      - !Ref DisconnectInteg
      DisconnectInteg:
      Type: AWS::ApiGatewayV2::Integration
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      Description: Disconnect Integration
      IntegrationType: AWS_PROXY
      IntegrationUri:
      Fn::Sub:
      arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${OnDisconnectFunction.Arn}/invocations
      SendRoute:
      Type: AWS::ApiGatewayV2::Route
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      RouteKey: sendmessage
      AuthorizationType: NONE
      OperationName: SendRoute
      Target: !Join
      - '/'
      - - 'integrations'
      - !Ref SendInteg
      SendInteg:
      Type: AWS::ApiGatewayV2::Integration
      Properties:
      ApiId: !Ref SimpleChatWebSocket
      Description: Send Integration
      IntegrationType: AWS_PROXY
      IntegrationUri:
      Fn::Sub:
      arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${SendMessageFunction.Arn}/invocations
  • Step4 ステージを追加

    1
    ステージは、API をデプロイできる個別に設定可能な環境です。API 設定の変更を有効にするには、ステージにデプロイする必要があります。開発や本稼働などの環境を表すステージを追加できます。
    • ステージ名
      • 任意のステージ名を定義
      • ex: Prod, dev
    • 次へ
  • SAMテンプレートでは以下のResourceが該当する

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    Deployment:
    Type: AWS::ApiGatewayV2::Deployment
    DependsOn:
    - ConnectRoute
    - SendRoute
    - DisconnectRoute
    Properties:
    ApiId: !Ref SimpleChatWebSocket
    Stage:
    Type: AWS::ApiGatewayV2::Stage
    Properties:
    StageName: Prod
    Description: Prod Stage
    DeploymentId: !Ref Deployment
    ApiId: !Ref SimpleChatWebSocket
  • Step5 作成してデプロイ

    • 内容を確認して”作成してデプロイ”を押下
    • ルートやステージが生成される
  • SAMテンプレートでは、ここまでの設定の他にLambda関数や実行環境、DynamoDBテーブルなどが定義されていた

  • 残りのResourceの詳細

    • AWS::DynamoDB::Table x 1
    • Lambda関数と権限 x 3セット
      • AWS::Serverless::Function x3
      • AWS::Lambda::Permission x 3

Lambda関数の構築(コンソールから)

  • コンソールから作る場合

    • Console/Lambda/関数の作成
    • sendMessage, onConnect, onDisconnectで関数を生成。コードスニペットを貼り付けてdeploy
  • コードスニペットはGitを参照

    • sendMessage関数
      • この関数は、クライアントの1つが送信したデータを受け取り、現在接続されているすべてのクライアントを検索し、それぞれに提供されたデータを送信する
    • onConnect関数
      • requestContextからのconnectionId値をDynamoDBテーブルに挿入する
    • onDisconnect関数
      • 指定されたconnectionId値に対応するレコードを削除
  • 手動の場合はAPI Gatewayとの統合と権限設定も必要

    • API GW.MychatAPI/ルート/各ルート/統合
      • 統合タイプ: Lambda関数として作成した関数を選択
  • SAMテンプレートでは以下のように表現される

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
ConnectionsTable:
Type: AWS::DynamoDB::Table
Properties:
AttributeDefinitions:
- AttributeName: "connectionId"
AttributeType: "S"
KeySchema:
- AttributeName: "connectionId"
KeyType: "HASH"
ProvisionedThroughput:
ReadCapacityUnits: 5
WriteCapacityUnits: 5
SSESpecification:
SSEEnabled: True
TableName: !Ref TableName
OnConnectFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: onconnect/
Handler: app.handler
MemorySize: 256
Runtime: nodejs12.x
Environment:
Variables:
TABLE_NAME: !Ref TableName
Policies:
- DynamoDBCrudPolicy:
TableName: !Ref TableName
OnConnectPermission:
Type: AWS::Lambda::Permission
DependsOn:
- SimpleChatWebSocket
Properties:
Action: lambda:InvokeFunction
FunctionName: !Ref OnConnectFunction
Principal: apigateway.amazonaws.com
OnDisconnectFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: ondisconnect/
Handler: app.handler
MemorySize: 256
Runtime: nodejs12.x
Environment:
Variables:
TABLE_NAME: !Ref TableName
Policies:
- DynamoDBCrudPolicy:
TableName: !Ref TableName
OnDisconnectPermission:
Type: AWS::Lambda::Permission
DependsOn:
- SimpleChatWebSocket
Properties:
Action: lambda:InvokeFunction
FunctionName: !Ref OnDisconnectFunction
Principal: apigateway.amazonaws.com
SendMessageFunction:
Type: AWS::Serverless::Function
Properties:
CodeUri: sendmessage/
Handler: app.handler
MemorySize: 256
Runtime: nodejs12.x
Environment:
Variables:
TABLE_NAME: !Ref TableName
Policies:
- DynamoDBCrudPolicy:
TableName: !Ref TableName
- Statement:
- Effect: Allow
Action:
- 'execute-api:ManageConnections'
Resource:
- !Sub 'arn:aws:execute-api:${AWS::Region}:${AWS::AccountId}:${SimpleChatWebSocket}/*'
SendMessagePermission:
Type: AWS::Lambda::Permission
DependsOn:
- SimpleChatWebSocket
Properties:
Action: lambda:InvokeFunction
FunctionName: !Ref SendMessageFunction
Principal: apigateway.amazonaws.com

SAR(Serverless Application Repository)で自動構築

  • SARにも今回の環境のテンプレートが公開されており、自動構築できる

  • 以下にアクセス

  • “Deploy”

  • 自分のAWSアカウントの確認画面で”デプロイ”

  • 以下のメッセージが表示された

    1
    承認が必要です。デプロイするには、[アプリケーション設定] セクションのチェックボックスをオンにしてください。
  • 該当箇所をチェック

    1
    このアプリがカスタム IAM ロールとリソースポリシーを作成することを承認します
  • デプロイを押下

  • Lambda/アプリケーションで生成されたAPスタックを確認することができる

  • 生成されていたリソース

    • DynamoDBテーブル: simplechat_connectionsはconnectionIdのみを保持する
    • API GW: SimpleChatWebSocket
      • $connect, $disconnect, sendMessageの3ルート
      • ダッシュボードからWebSocket URLを確認することができる
    • Lambda関数

      SAMテンプレートで自動構築

  • SAM CLIを使えば、SAMテンプレートで今回の構成を構築することもできる

    • SARでは裏側でSAMテンプレートを使っている
  • 今回のチャットAPのSAM Template手元にクローンしてCLIから実行する

### WebSocketAPIの検証/検証ツール wscat

  • WebSocket APIのテストには、OSSのコマンドラインツール wscatが役立つ
  1. NPMをインストールします。
  2. wscatをインストール
    1
    $ npm install -g wscat
  3. コンソールで、次のコマンドを実行して公開APIエンドポイントに接続します。
    • AWS Cnsole/API Gateway/My Chat APIのダッシュボードでWeb Socket URLとして下記のURLを確認出来る
      1
      2
      $ wscat -c wss://{YOUR-API-ID}.execute-api.{YOUR-REGION}.amazonaws.com/{STAGE}
      Bash
  4. sendMessage関数をテストするには、次の例のようなJSONメッセージを送信する。 Lambda関数はコールバックURLを使用してそれを返す:
    1
    2
    3
    4
    $ wscat -c wss://{YOUR-API-ID}.execute-api.{YOUR-REGION}.amazonaws.com/dev
    connected (press CTRL+C to quit)
    > {"action":"sendmessage", "data":"hello world"}
    < hello world
  • wscatを複数のコンソールで実行すると、それぞれが “hello world”を受信する。これで、WebSocket APIからメッセージを送信したり、応答を返すことができるようになったと言える
  • この検証方法は今回のサンプル以外でも使えそう

参考

関連記事

その他

@EventEmitter @Input @Output @ViewChild ACM AMP API Gateway AR AR.js AR.js Studio AWS AWS Amplify AWS Budgets AWS Cost Explorer AWS SDK for JavaScript AddThis Adobe XD Alexa Amazon CloudWatch Amazon Honycode Amazon SNS Android Angular Angular Material AngularFire AppSync Augury C CDN CI/CD Cloud Craft Cloud9 CloudFormation CloudFront CloudTrail Cognito Cost Anomaly Detection Cubase ai Cubasis LE DTM Disqus DynamoDB Elgato HD 60S Firebase Firebase Hosting Former2 Github Github Actions Github.com GithubEnterprise GithubPages Google Chrome Google Cloud Shell GraphQL Hexo Hosting IAM Ionic JSON JavaScript LadioCast Logging LowCode MFA MS Authentication MacBook Pro 16 Mind Node NETDUETTO Netflix Party Netlify Network NoCode Observable PO PdM Promise RPA ReactiveForm Recognition Route53 S3 SAM(Serverless Application Model) SAR SSL SYNCROOM Schematics ScrumInc Serverless Service Siri Sitemap Spark AR Steinberg UR44C Teams Touch Cast Studio Treetable TypeScript UI UI Bakery WAF WAFv2 WEB Page Dev WEB会議 WebAR WebSocketAPI Webhook Windows Power Automate Wireshark aot async/await aws config cloud9 display.land draw.io e2e test filter() forkJoin() google search console hexo-generator-amp iOS iPad Pro iPhone icarus map() mat input mat tree mat-checkbox mat-input mat-selection-list mmhmm ngFor plantUML popIn Aladdin2 then() vscode ”global is not defined” らくがきAR アジャイル アジャイル開発 クロスプラットフォーム ショートカット スクラム スクラム開発 テレワーク ファイル操作 ブラウザ型IDE プロダクトオーナー プロダクトマネージャー プロトタイピング リモートセッション 共同開発 双方向データバインディング 待ち合わせ処理 認定スクラムマスター 静的WEB Hosting 静的WEBサイトHosting
Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×