Éditeur et testeur OpenAPI

Outils OpenAPI

La spécification OpenAPI (OAS) est une norme qui décrit les API web dans un format indépendant du langage de programmation. Elle crée un plan qui explique la manière dont les applications logicielles communiquent sur Internet. Les développeurs utilisent OpenAPI pour écrire des instructions en JSON ou YAML qui décrivent les détails de l'API, les points de terminaison, les données et les considérations de sécurité. Cette description standardisée permet à d'autres programmes d'interagir avec l'API sans voir son code interne.

XMLSpy comprend des outils intelligents pour travailler avec OpenAPI pendant le développement ou la découverte, notamment la validation, l'édition et les tests.

Édition de documents OpenAPI

Que votre document OpenAPI soit écrit en JSON ou en YAML, l'éditeur OpenAPI basé sur du texte de XMLSpy offre des fonctionnalités d'édition intelligentes telles que la coloration syntaxique, le pliage de source, la saisie automatique et les aides à la saisie.

Si vous passez en mode Grille, XMLSpy fournit une représentation graphique de la structure du document qui facilite la navigation, la compréhension et l'édition. Outre les outils d'édition intelligents, le mode Grille offre des commandes dans les cellules, l'édition visuelle par glisser-déposer et un mode Tableau pour réorganiser l'affichage des nœuds. Vous pouvez également développer et réduire des sections de données pour naviguer dans des fichiers volumineux et localiser des éléments spécifiques.

Les modes Texte et Grille permettent tous deux de valider les documents par rapport à la spécification OpenAPI.

Lorsque vous partez de zéro, XMLSpy propose des modèles intégrés pour créer de nouveaux documents OpenAPI, avec prise en charge des versions OpenAPI 2.0, 3.0, 3.1 et 3.2.

XMLSpy comprend une fenêtre de test HTTP utile avec prise en charge d'OpenAPI. Cette fenêtre vous guide tout au long du processus de création et d'envoi d'une requête HTTP à une API existante. Vous pouvez ensuite recevoir, vérifier et réparer la réponse directement dans la fenêtre.

En fonction de l'opération et des paramètres que vous sélectionnez pour le test, XMLSpy génère automatiquement le message de test, que vous pouvez envoyer à l'API, puis affiche les résultats.

Vous pouvez également générer une requête directement à partir du fichier OpenAPI que vous êtes en train de modifier. Il suffit de cliquer avec le bouton droit sur n'importe quelle opération pour que XMLSpy récupère son chemin d'accès, sa méthode, ses paramètres et le corps de la requête, puis ouvre une requête prête à être envoyée dans la fenêtre de test HTTP.

Les tests couvrent l'ensemble des requêtes acceptées par une API type, y compris les requêtes multipart/form-data pour les téléchargements de fichiers et le contenu mixte. Lorsqu’une opération attend un corps multipart, XMLSpy pré-remplit les parties à partir de la définition OpenAPI ; il ne vous reste plus qu’à renseigner les valeurs et les chemins d’accès aux fichiers, puis à envoyer la requête.

La possibilité d'envoyer des requêtes et d'inspecter les réponses garantit que l'API se comporte comme prévu pendant le développement et l'intégration. Il s'agit d'un outil efficace pour tester vos propres API et explorer des interfaces tierces.