Modifier et valider des documents OpenAPI
Un document OpenAPI (OA) est rédigé en YAML ou en JSON et est conforme à la spécification OA (OAS, formellement implémentée sous la forme d’un schéma JSON).
Prise en charge de l'édition des documents OpenAPI
XMLSpy offre les fonctionnalités d'édition et de traitement suivantes pour les documents OpenAPI :
•Détecte les documents OpenAPI (au format YAML ou JSON) en fonction de leur contenu
•Lit la version OpenAPI à partir du mot-clé obligatoire openapi
•Valide le document OpenAPI par rapport à la version OAS détectée
•Affiche les informations du document dans la fenêtre Info
•Permet l'édition dans le Mode texte et le Mode grille. Les fonctionnalités d'édition de ces deux modes sont disponibles lorsque cela est pertinent, par exemple la coloration syntaxique et les marges de pliage
•Fournit une aide à la saisie et à l'auto-complétion
•Fournit des modèles YAML pour les nouveaux documents OpenAPI. Un fichier modèle est disponible pour chacune des versions OAS prises en charge
•Lorsque vous passez le document OpenAPI en Mode Schéma, vous pouvez modifier graphiquement les schémas internes du document.
Valider les documents OpenAPI
XMLSpy valide les documents OA par rapport aux versions OAS suivantes : 2.0, 3.0, 3.1, et 3.2.
Chaque document OA commence par une clé obligatoire, telle qu'indiquée dans le tableau ci-dessous, suivie de la valeur correspondante.
Version OAS | Clé | Valeur |
2.0 | swagger | 2.0 |
3.0 | openapi | 3.0.x |
3.1 | openapi | 3.1.x |
3.2 | openapi | 3.2.x |
Pour valider le document OpenAPI actif, sélectionnez la commande de menu XML | Valider XML (F8). Le document OA sera validé par rapport à la version OAS correspondante et à tout schéma interne supplémentaire que le document pourrait contenir.