OpenAPI
La spécification OpenAPI (OAS) définit une interface standard pour les API HTTP. Elle permet à une application cliente d'interagir avec un service distant sans que le client ait besoin de lire le code source, ce qui ne nécessite qu'une quantité minimale de logique d'implémentation. Le créateur de l'API décrit l'API dans un document YAML ou JSON en utilisant des termes standardisés fournis par la spécification OpenAPI, qui reflète les concepts du monde des API et intègre les procédures HTTP.
XMLSpy fournit la prise en charge suivante pour OpenAPI :
•Validation des documents OpenAPI par rapport à l'OAS. Un document OpenAPI est un fichier au format YAML ou JSON qui décrit une API conforme à la spécification OpenAPI.
•Prise en charge de l'édition des documents OpenAPI, telle que la coloration syntaxique, les marges repliables et la saisie automatique.
•Création et envoi d'une requête HTTP basée sur un document OpenAPI, réception et affichage de la réponse.
Validation des documents OpenAPI
Un document OpenAPI (OA) est écrit en YAML ou JSON et est conforme à la spécification OA (implémentée formellement comme un schéma JSON). XMLSpy valide les documents OA par rapport aux versions OAS suivantes : 2.0, 3.0, et 3.1.
Chaque document OA commence par une clé obligatoire, comme indiqué dans le tableau ci-dessous, et la valeur de clé correspondante.
Version OAS | Clé | Valeur |
2.0 | swagger | 2.0 |
3.0 | openapi | 3.0.x |
3.1 | openapi | 3.1.x |
Pour valider le document OpenAPI actif, sélectionnez la commande de menu XML | Valider XML (F8).
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
Demandes HTTP à partir de documents OpenAPI
Dans XMLSpy, vous pouvez créer des demandes HTTP à partir d'un document OpenAPI. La procédure ci-dessous décrit comment procéder en créant une demande HTTP GET à partir d'un fichier de document OpenAPI et en soumettant la demande à un service web.
1.Dans la fenêtre HTTP, cliquez sur Créer une requête HTTP à partir de WSDL, WADL ou OpenAPI.
2.Dans le dialogue qui s'affiche, entrez l'emplacement du fichier de document OpenAPI et cliquez sur OK. Par exemple : https://petstore3.swagger.io/api/v3/openapi.json.
3.Dans le dialogue suivant, Sélectionner une opération, sélectionnez le chemin d'accès et l'opération souhaités. Par exemple, dans la capture d'écran ci-dessous, le chemin sélectionné est /pet/findByStatus et son opération GET est l'opération sélectionnée.
4.Lorsque vous cliquez sur OK, le dialogue Paramètres de requête HTTP s'affiche (capture d'écran ci-dessous). Les valeurs qui ont été définies dans le document OpenAPI pour ce paramètre s'affichent dans la liste déroulante de la colonne Valeurs. Sélectionnez la valeur souhaitée et cliquez sur OK.
5.La requête GET sera créée et son URI s'affichera en haut de la fenêtre HTTP (voir la capture d'écran ci-dessous).
6.Lorsque vous cliquez sur Envoyer, la requête sera envoyée et la réponse s'affichera dans le volet Résultats à droite (voir la capture d'écran ci-dessous).
Pour plus d'informations, voir également les rubriques HTTP suivantes : Envoyer la requête et Recevoir la réponse.