websocketaws-api-gateway

Setup a basic WebSocket mock in AWS ApiGateway

I am trying to setup an extremely simple WebSocket mock within AWS ApiGateway. However, every attempt I've tried gives me an error:

13:36:52 (X33uOGUfIAMFq7w=) Extended Request Id: X33uOGUfIAMFq7w=
13:36:52 (X33uOGUfIAMFq7w=) Verifying Usage Plan for request: X33uOGUfIAMFq7w=. API Key: API Stage: redacted/prod
13:36:52 (X33uOGUfIAMFq7w=) API Key authorized because route '$connect' does not require API Key. Request will not contribute to throttle or quota limits
13:36:52 (X33uOGUfIAMFq7w=) Usage Plan check succeeded for API Key and API Stage redacted/prod
13:36:52 (X33uOGUfIAMFq7w=) Starting execution for request: X33uOGUfIAMFq7w=
13:36:52 (X33uOGUfIAMFq7w=) WebSocket Request Route: [$connect]
13:36:52 (X33uOGUfIAMFq7w=) Client [UserAgent: null, SourceIp: redacted] attempts to connect to WebSocket API [redacted].
13:36:52 (X33uOGUfIAMFq7w=) Execution failed due to configuration error: statusCode should be an integer which defined in request template
13:36:52 (X33uOGUfIAMFq7w=) Client [UserAgent: null, SourceIp: redacted] failed to connect to API [redacted].

As far as I can tell, I've followed the most basic configuration possible. I do not need any responses or templates, just simple a WebSocket connection that allows me to connect to it and do nothing, or perhaps respond to ping requests with a pong eventaully.

api route $connect

All authorizations and API keys are disabled. No request templates or integration responses are setup since I do not need them. Again, the goal is to just be able to have a dumb WebSocket that can be connected to.

no request templates

However, whenever I try to connect to it, I get a 500 error with the error logs from above about a status code.

WebSocket connection to 'wss://redacted.execute-api.us-east-1.amazonaws.com/prod' failed: Error during WebSocket handshake: Unexpected response code: 500
Solution

  • Using the following sources (below), I was able to get a quick and loose example AWS API Gateway connection working use MOCK endpoints with web sockets. I'm sure this can be flushed out more to provide an even better understanding of different request/response body messages and codes..

    1. First, go to API Gateway, click Create API

    2. For Choose the protocol, select WebSocket

    3. Give the API a name, and use the example $request.body.message for the route selection expression

    4. Click the Create API button

    5. Select the new API from the side pane, and click Routes

    6. Select the $connect route

    7. Under Route overview, select the Mock radio button for endpoint

    8. For the Request Template, enter an expression (using 200 for example).

    9. For Template Key, enter a key (using 200 for example)

    10. For the popup window on passthrough behavior, select No, Use Current Settings for now

    11. Click on the Template Key 200, and enter a template: {"statusCode" : 200} and then click the Save button. connect integration request

    12. Select Route Overview to go back to the $connect overview page and then select the Add Integration Response button

    13. Create a response key of $default, which will reference the $default key under Routes connect integration response

    14. For the $disconnect route, please repeat steps 7 - 13 for this specific route. disconnect route

    15. Once done setting up the $disconnect route, please select the $default route under the Routes pane. default route

    16. Create an Integration Request the same way that was done for $connect and $disconnect (steps 7 - 11)

    17. For Integration Response under $default, we will be setting the route response up slightly different than $connect and $disconnect as those 2 routes' responses actually reference the $default response within their own respective Integration Responses.

    18. Create a response key of $default

    19. Enter a Template Selection Expression (using 200 for this example)

    20. Then create a Template Key (using 200 for this example)

    21. Click on the Template Key 200, and enter a template: {"statusCode" : 200, "connectionId" : "$context.connectionId"} and then click the Save button. default response

    22. {"connectionId" : "$context.connectionId"} was added to the response payload to show how variables can be used within the response to represent an actual value of the connection.

    23. Finally, under the Actions dropdown, select Deploy API, and enter a deployment stage name. This should generate a WebSocket URL that can now be connected to e.g. (wss://#######.execute-api.us-east-1.amazonaws.com/Test)

    24. Using wscat via cli, I am now able to connect to my WebSocket URL (see source below for installing wscat): wscat -c wss://#######.execute-api.us-east-1.amazonaws.com/Test cli websocket

    Sources: