Mode de compatibilité d'API gateway - Cloud

Guide d'utilisation de Talend Cloud API Designer

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Création et développement > Création d'APIs
EnrichPlatform
Talend API Designer

Talend Cloud API Designer offre un mode de compatibilité d'API gateway afin de vous permettre d'importer votre définition dans AWS API Gateway et Azure API Management.

Lors de l'export de votre API en mode compatibilité d'API gateway, Talend Cloud API Designer peut modifier votre définition pour que vous puissez l'importer dans la passerelle sélectionnée.

Dans certains cas, aucune modification n'est effectuée mais un message s'affiche, vous informant d'un possible problème de compatibilité dans la définition exportée.

Exporter une définition OAS 3.0 pour AWS API Gateway

Le tableau suivant décrit comment Talend Cloud API Designer gère les fonctionnalités non supportées par AWS API Gateway lors de l'export d'une définition et ce qu'il se passe dans AWS API Gateway when lorsque vous importez la définition.

Fonctionnalité non supportée d'OpenAPI Comportement de Talend Cloud API Designer lors de l'export Comportement de AWS API Gateway lors de l'import
L'attribut example n'est pas supporté. L'attribut est préservé. L'attribut est supprimé du schéma.
L'attribut readOnly n'est pas supporté. L'attribut est préservé. L'attribut est supprimé du schéma.
L'attribut additionalProperties n'est pas supporté. L'attribut est préservé et un message informatif s'affiche. Un avertissement s'affiche mais peut être ignoré. La définition peut s'importer correctement.
Types de définition de sécurité :
  • oauth2 n'est pas supporté,
  • http n'est pas supporté,
  • openIdConnect n'est pas supporté.
Les schémas de sécurité sont préservés et un message informatif s'affiche. Un avertissement s'affiche mais peut être ignoré. La définition peut s'importer correctement.
Les types de données primitifs dans les réponses ne sont pas supportés. Le type primitif est intégré dans un schéma de composant et un avertissement s'affiche. L'import est réussi.
Les plages de types de média ne sont pas supportées. La requête ou la réponse est préservée et un message informatif s'affiche. L'import échoue et un avertissement s'affiche.
La réponse par défaut n'est pas supportée. La réponse est préservée et un message informatif s'affiche. L'import échoue et un avertissement s'affiche.
Les plages de réponses ne sont pas supportées. La réponse est préservée et un message informatif s'affiche. L'import échoue et un avertissement s'affiche.
Les variables de ressource, les paramètres de requêtes et les en-têtes doivent avoir des noms uniques. Les paramètres sont préservés et un message d'erreur s'affiche. L'import échoue.

Exporter une définition OAS/Swagger 2.0 pour Azure API Management

Le tableau suivant décrit comment Talend Cloud API Designer gère les fonctionnalités non supportées par Azure API Management lors de l'export d'une définition et ce qui se passe dans Azure API Management lorsque vous importez la définition.

Fonctionnalité non supportée d'OpenAPI Comportement de Talend Cloud API Designer lors de l'export Comportement de Azure API Management lors de l'import
Les paramètres requis pour les chemins et les requêtes doivent avoir des noms uniques. Un message d'erreur s'affiche. L'import échoue.