Validation de la source YAML OpenAPI
Comment valider la source YAML OpenAPI par rapport aux spécifications swagger lorsque vous éditez une API.
A propos de cette tâche
Lorsque vous configurez une API dans l'éditeur d'API, vous pouvez valider la source YAML OpenAPI en cliquant sur . 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, sauvegarder les mises à jour et continuer à valider le fichier YAML OpenAPI tout au long du processus de configuration de l'API.
Remarque :
- La validation OpenAPI n'affiche pas les erreurs de passerelle ou de stratégie qui empêchent votre API d'être mise en préproduction ou publiée. Ce type de validation se produit uniquement lorsque vous tentez de mettre en préproduction ou de publier votre API. Pour plus d'informations, voir Transfert d'une API ou Publication d'une API.
- Vous pouvez également valider votre document d'API en utilisant des ensembles de règles de gouvernance . Pour plus d'informations, voir Validation d'une API ou d'un document de 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 dans la barre de menus de l'en-tête.
- 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 dans la vue Formulaire
, vous pouvez cliquer sur une erreur individuelle pour accéder directement à la section d'API appropriée 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,
.