Création WebSocket d'API dans API Gateway - Amazon API Gateway
Création d'une WebSocket API à l'aide de AWS CLI commandesCréation d'une WebSocket API à l'aide de la console API Gateway

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Création WebSocket d'API dans API Gateway

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

Note

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

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

La création d'une WebSocket API à l'aide de la commande create-api AWS CLI nécessite l'appel de la commande create-api, comme indiqué dans l'exemple suivant, qui crée une API avec l'expression de sélection d'$request.body.actionitinéraire :

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

Exemple de sortie :

{
    "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 WebSocket API à l'aide de la console API Gateway

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

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 WebSocket API en API REST ou vice versa.

Pour créer une WebSocket API à 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, choisissez Build. 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.