API Gateway prend en charge l'importation et l'exportation de définitions d'API conformes à la norme OpenAPI Specification (OAS), y compris les extensions compatibles OAS. Utilisez ces fonctionnalités pour migrer vos API existantes et gérer les données d'API entre différents comptes, régions et plateformes.
Importer des API conformes à OAS
API Gateway permet d'importer des définitions d'API conformes aux versions OAS 2.0 ou OAS 3.0. Vous pouvez également importer des extensions compatibles OAS afin de migrer vos API existantes vers API Gateway sans aucune modification. Cette rubrique aborde les points suivants :
Les correspondances de paramètres entre une définition d'API conforme à OAS 2.0 et une définition d'API API Gateway.
Les correspondances de paramètres entre une définition d'API conforme à OAS 3.0 et une définition d'API API Gateway.
L'importation de définitions d'API conformes à OAS 2.0 contenant des extensions API Gateway.
Exporter des API au format OAS
API Gateway permet d'exporter des définitions d'API aux formats OAS 2.0 ou OAS 3.0, ce qui facilite la migration des données d'API entre différents comptes, régions ou plateformes. Cette rubrique couvre les aspects suivants :
-
Exportation d'API conformes à OAS.
Vous avez la possibilité d'exporter un groupe d'API entier ou des API spécifiques.
Importer une définition Swagger étendue
Importez un fichier Swagger 2.0 pour créer une API dans la console API Gateway ou en appelant l'opération ImportSwagger. Cette section détaille les éléments suivants :
Extensions prises en charge par Swagger : Swagger permet d'étendre son objet natif Operation Object. Ces extensions offrent des capacités d'authentification, de mappage de paramètres et de service backend.
Compatibilité : correspondances des types de paramètres entre Swagger et API Gateway.
Exemples d'extensions Swagger : illustrations d'extensions Swagger pour API Gateway.
Remarques importantes : considérations clés lors de l'utilisation de cette fonctionnalité.