Mode de compatibilité de la passerelle d'API
API Designer offre un mode de compatibilité de passerelle d'API pour vous aider à importer votre définition dans AWS API Gateway et dans Azure API Management.
Lorsque vous exportez votre API en mode de compatibilité de passerelle, API Designer peut modifier votre définition afin qu'elle puisse être importée correctement dans la passerelle sélectionnée.
Dans certains cas, il n'y a pas de modifications, mais un message s'affiche pour vous informer du problème de compatibilité que vous pourriez rencontrer avec la définition que vous avez exportée.
Exporter une définition OAS 3.0 pour AWS API Gateway
Le tableau suivant indique comment API Designer gère les fonctionnalités non supportées par AWS API Gateway lors de l'exportation d'une définition et ce qui se passe dans AWS API Gateway lorsque vous importez la définition.
| Fonctionnalité OpenAPI non supportée | Comportement d'API Designer à l'exportation | Comportement d'AWS API Gateway à l'importation |
|---|---|---|
| L'attribut example n'est pas supporté. | L'attribut est conservé. | L'attribut est supprimé du schéma. |
| L'attribut readOnly n'est pas supporté. | L'attribut est conservé. | L'attribut est supprimé du schéma. |
| L'attribut additionalProperties n'est pas supporté. | L'attribut est conservé et un message d'information est affiché. | Un message d'avertissement est affiché, mais il peut être ignoré et la définition peut être importée correctement. |
Types de définition de sécurité :
|
Les schémas de sécurité sont conservés et un message d'information est affiché. | Un message d'avertissement est affiché, mais il peut être ignoré et la définition peut être importée correctement. |
| Les types de données primitifs dans les réponses ne sont pas supportés. | Le type primitif est enveloppé dans un schéma de composant et un message d'avertissement est affiché. | L'importation s'effectue correctement. |
| Les plages de types de média ne sont pas supportées. | La requête ou la réponse est conservée et un message d'information est affiché. | L'importation échoue et un message d'avertissement est affiché. |
| La réponse par défaut n'est pas supportée. | La réponse est conservée et un message d'information est affiché. | L'importation échoue et un message d'avertissement est affiché. |
| Les réponses de plages ne sont pas supportées. | La réponse est conservée et un message d'information est affiché. | L'importation échoue et un message d'avertissement est affiché. |
| Les variables de chemin d'accès, les paramètres de requête et les en-têtes doivent avoir des noms uniques. | Les paramètres sont conservés et un message d'erreur s'affiche. | L'importation échoue. |
Exportation d'une définition OAS/Swagger 2.0 pour Azure API Management
Le tableau suivant indique comment API Designer gère les fonctionnalités non supportées par Azure API Management lors de l'exportation d'une définition et ce qui se passe dans Azure API Management lorsque vous importez la définition.
| Fonctionnalité OpenAPI non supportée | Comportement d'API Designer à l'exportation | Comportement d'Azure API Management à l'importation |
|---|---|---|
| Les paramètres requis des chemins d'accès et des requêtes doivent avoir des noms uniques. | Un message d'erreur est affiché. | L'importation échoue. |