Création d’une API WebSocket dans API Gateway

Vous pouvez créer une API WebSocket dans la console API Gateway, à l’aide de la commande create-api de l’AWS CLI ou de la commande CreateApi d’un kit AWS SDK. Les procédures suivantes montrent comment créer une API WebSocket.

Note

Les API WebSocket prennent uniquement en charge les protocoles TLS 1.2 et TLS 1.3. Les versions antérieures de TLS ne sont pas prises en charge.

Création d’une API WebSocket à l’aide de commandes de l’AWS CLI

La commande create-api suivante crée une API avec l’expression de sélection de route $request.body.action :

aws apigatewayv2 --region us-east-1 create-api --name "myWebSocketApi3" --protocol-type WEBSOCKET --route-selection-expression '$request.body.action'

Le résultat se présente comme suit :

{
    "ApiKeySelectionExpression": "$request.header.x-api-key",
    "Name": "myWebSocketApi3",
    "CreatedDate": "2018-11-15T06:23:51Z",
    "ProtocolType": "WEBSOCKET",
    "RouteSelectionExpression": "'$request.body.action'",
    "ApiId": "aabbccddee"
}

Création d’une API WebSocket à l’aide de la console API Gateway

Vous pouvez créer une API WebSocket dans la console en choisissant le protocole WebSocket et en attribuant un nom à l’API.

Important

Une fois l’API créée, vous ne pouvez pas modifier le protocole que vous avez choisi. Il n’existe aucun moyen de convertir une API WebSocket en API REST ou vice versa.

Pour créer une API WebSocket à l’aide de la console API Gateway

1. Connectez-vous à la console API Gateway et choisissez Create API (Créer une API).

2. Sous WebSocket API (API WebSocket), choisissez Build (Création). Seuls les points de terminaison régionaux sont pris en charge.

3. Pour Nom de l’API, saisissez le nom de votre API.

4. Pour Expression de sélection de routage, saisissez une valeur. Par exemple, $request.body.action.

   Pour plus d’informations sur les expressions de sélection de la route, consultez la section Expressions de sélection de la route.

5. Effectuez l’une des actions suivantes :

   • Choisissez Créer une API vide pour créer une API sans routes.

   • Choisissez Suivant pour joindre des routes à votre API.

   Vous pouvez joindre des routes après avoir créé votre API.