Exporter des API HTTP depuis API Gateway - APIPasserelle Amazon
Exporter une définition OpenAPI 3.0 d'une étape à l'aide de la CLI AWSExportez une définition OpenAPI 3.0 des dernières modifications de votre API à l'aide de la CLI AWSExportation d'une définition OpenAPI 3.0 à 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.

Exporter des API HTTP depuis API Gateway

Après avoir créé une API HTTP, vous pouvez exporter une définition OpenAPI 3.0 de votre API à partir d'API Gateway. Vous pouvez choisir une étape à exporter ou exporter la dernière configuration de votre API. Vous pouvez également importer une définition d'API exportée dans API Gateway pour créer une autre API identique. Pour de plus amples informations sur l'importation de définitions d'API, veuillez consulter Importation d'une API HTTP.

Exporter une définition OpenAPI 3.0 d'une étape à l'aide de la CLI AWS

La commande suivante exporte une définition OpenAPI d'une étape d’API nommée prod dans un fichier YAML intitulé stage-definition.yaml. Le fichier de définition exporté inclut les extensions API Gateway par défaut.

aws apigatewayv2 export-api \
    --api-id api-id  \
    --output-type YAML  \
    --specification OAS30 \
    --stage-name prod \
    stage-definition.yaml

Exportez une définition OpenAPI 3.0 des dernières modifications de votre API à l'aide de la CLI AWS

La commande suivante exporte une définition OpenAPI d'une API HTTP vers un fichier JSON intitulé latest-api-definition.json. Étant donné que la commande ne spécifie pas d'étape, API Gateway exporte la dernière configuration de votre API, qu'elle ait été déployée ou non sur une étape. Le fichier de définition exporté n'inclut pas les extensions API Gateway.

aws apigatewayv2 export-api \
    --api-id api-id  \
    --output-type JSON  \
    --specification OAS30 \
    --no-include-extensions \
    latest-api-definition.json

Pour de plus amples informations, veuillez consulter ExportAPI dans le document Référence des API Amazon API Gateway Version 2.

Exportation d'une définition OpenAPI 3.0 à l'aide de la console API Gateway

La procédure suivante illustre comment exporter une définition OpenAPI d'une API HTTP.

Pour exporter une définition OpenAPI 3.0 à l'aide de la console API Gateway

  1. Connectez-vous à la console API Gateway à l'adresse : https://console.aws.amazon.com/apigateway.

  2. Choisissez une API HTTP.

  3. Dans le panneau de navigation principal, sous Développer, choisissez Exporter.

  4. Sélectionnez l'une des options suivantes pour exporter votre API :

    Options d'exportation pour les API HTTP

    1. Pour Source, sélectionnez une source pour la définition OpenAPI 3.0. Vous pouvez choisir une étape à exporter ou exporter la dernière configuration de votre API.

    2. Activez l'option Inclure les extensions API Gateway pour inclure les extensions API Gateway.

    3. Pour Format de sortie, sélectionnez un format de sortie.

  5. Choisissez Téléchargement.