Validation de la source YAML OpenAPI

Modifier en ligne

Comment vérifier la conformité du fichier YAML de l' OpenAPI. avec les spécifications Swagger lorsque vous modifiez une API.

A propos de cette tâche

Lorsque vous configurez une API dans l'éditeur d'API, vous pouvez valider le fichier YAML de l' OpenAPI en cliquant sur Valider > Avec les spécifications. Si des erreurs de validation de l'analyseur syntaxique swagger sont détectées, une icône d'erreur s'affiche, sur laquelle vous pouvez cliquer pour afficher les erreurs individuelles et leur emplacement dans le fichier YAML. Vous pouvez ensuite corriger les erreurs, enregistrer les modifications et continuer à valider le fichier YAML de l' OpenAPI tout au long du processus de configuration de l'API.

Remarque :

OpenAPI La validation ne révèle aucune erreur de passerelle ou de stratégie susceptible d'empêcher la mise en production ou la publication de votre API. Ce type de validation se produit uniquement lorsque vous tentez de mettre en préproduction ou de publier votre API. Pour plus d'informations, consultez les sections « Mise en place d'une API » ou « Publication d'une API ».
Vous pouvez également valider votre documentation API à l'aide de jeux de règles de gouvernance. Pour plus d'informations, consultez la section « Validation d'une API ou d'une documentation produit à l'aide du service de gouvernance ».

Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.

Procédure

Pour valider la source YAML OpenAPI , procédez comme suit.

Ouvrez l'API requise pour l'édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0 ou Edition d'une définition d'API OpenAPI 3.0.
Cliquez sur « Valider > Avec spécifications » dans la barre de menu en haut de la page.
Si des erreurs de validation de l'analyseur syntaxique swagger sont détectées, une icône d'erreur s'affiche dans la barre de menu d'en-tête, avec le nombre d'erreurs OpenAPI trouvées en regard de l'icône.
Par exemple, .
Vous pouvez ensuite cliquer sur l'icône d'erreur pour afficher la liste détaillée des erreurs et leur emplacement dans le fichier YAML. Si vous êtes en mode « Formulaire », vous pouvez cliquer sur une erreur spécifique pour accéder directement à la section correspondante de l'API dans le formulaire.
Après avoir corrigé l'erreur, cliquez sur Sauvegarder pour sauvegarder vos mises à jour, puis cliquez à nouveau sur Valider .
Lorsque toutes les erreurs sont corrigées, la validation renvoie un message de réussite.
Par exemple, .