Transformations à l'exportation
Lors de l'exportation d'une définition conçue avec les fonctionnalités API Designer dans un format qui ne les supporte pas, la définition est modifiée pour s'adapter au format cible. Une certaine expressivité est perdue au cours du processus.
Le tableau ci-dessous décrit les modifications apportées à votre définition d'API lors de l'exportation dans l'une des spécifications suivantes :
- OAS/Swagger 2.0
- Swagger 1.2
- RAML 1.0
| Fonctionnalité non supportée | Transformation |
|---|---|
| Composants | Le composant est copié à chaque endroit où il est utilisé. |
| Plages de réponses et réponses par défaut | La réponse est supprimée. |
| Authentification du porteur et OpenID Connect | Le schéma de sécurité est supprimé. |
| Combinaisons allOf | La combinaison est remplacée par un objet contenant toutes les propriétés de tous les types utilisés. |
| Combinaisons anyOf et oneOf | La combinaison est remplacée par un objet vide. |
| Endpoints multiples | Le premier endpoint publié est compris dans la définition, les autres sont ignorés. |
La spécification OpenAPI 3.0 ne supporte que les URL dans le champ Terms of service. Lors de l'exportation d'une définition au format OAS 3.0, ce champ n'est exporté que s'il contient une URL. Si ce n'est pas le cas, le champ Terms of service (Conditions d'utilisation) est ignoré pour garantir la validité de la définition.