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.

Déploiement d’API WebSocket dans API Gateway

Après avoir créé votre API WebSocket, vous devez la déployer pour permettre à vos utilisateurs de l’invoquer.

Pour déployer une API, vous devez créer un déploiement d’API et l’associer à une étape. Chaque étape est un instantané de l’API et peut être appelée par les applications client.

Pour appeler une API WebSocket déployée, le client envoie un message à l’URL de l’API. L’URL est déterminée par le nom d’hôte et le nom de l’étape de l’API.

Avec le nom de domaine par défaut de l’API, l’URL (par exemple) d’une API WebSocket à une étape donnée ({stageName}) se présente au format suivant :

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

Pour rendre l’URL de l’API WebSocket plus conviviale, vous pouvez créer un nom de domaine personnalisé (par exemple, api.example.com) pour remplacer le nom d’hôte par défaut de l’API. Le processus de configuration est le même que pour les API REST. Pour de plus amples informations, veuillez consulter Nom de domaine personnalisé pour le REST public APIs dans API Gateway.

Les étapes permettent un contrôle de version solide de votre API. Par exemple, vous pouvez déployer une API dans une étape test et une étape prod, puis utiliser l’étape test comme version de test et l’étape prod comme version stable. Une fois que les mises à jour passent le test, vous pouvez migrer l’étape test vers l’étape prod. La promotion peut être effectuée en redéployant l’API à l’étape prod. Pour plus d’informations sur les étapes, consultez Configuration d’une étape pour une API REST dans API Gateway.

Création d’un déploiement d’API WebSocket à l’aide de l’AWS CLI

La commande create-deployment suivante crée un déploiement :

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

Le résultat se présente comme suit :

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

L’API déployée ne peut pas être appelée tant que vous n’associez pas le déploiement à une étape. Vous pouvez créer une nouvelle étape ou réutiliser une étape créée précédemment.

La commande create-stage suivante crée une étape et l’associe au déploiement :

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

Le résultat se présente comme suit :

{
    "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": {}
}

Vous pouvez également réutiliser une étape existante en remplaçant sa propriété deploymentId par l’ID du déploiement que vous venez de créer (deployment-id). La commande update-stage suivante met à jour l’ID de déploiement de l’étape :

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

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

Pour utiliser la console API Gateway afin de créer un déploiement pour une API WebSocket :