Éditeur et testeur OpenAPI

Modifiez, validez et testez des documents OpenAPI

  • Éditeur OpenAPI intelligent
  • Options d'édition texte et graphique
  • Validation basée sur OpenAPI
  • Mise en évidence de la syntaxe, pliage de source, aides à la saisie
  • Modification du schéma JSON basé sur OAS
  • Prise en charge d'OpenAPI 1.0, 2.0, 3.0
  • Modèles YAML pour les nouvelles définitions OpenAPI
  • Éditeurs YAML et JSON intelligents
  • Création et test de requêtes HTTP 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.

Éditeur JSON Schema

L'éditeur graphique JSON Schema dans XMLSpy prend en charge la validation et l'édition de schémas JSON basés sur l'OAS. L'interface visuelle facilite le travail des développeurs avec des schémas OpenAPI complexes en offrant une représentation graphique de la structure qui permet de mieux comprendre et d'identifier les erreurs ou les incohérences.

L'éditeur JSON Schema prend en charge les extensions OAS, notamment les discriminateurs, xml, format et documents externes qui peuvent être configurés dans l'aide à la saisie Détails.

É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.

Éditeur OpenAPI dans XMLSpy

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.

Vue d'édition graphique OpenAPI

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 inclut des modèles intégrés pour créer de nouveaux documents OpenAPI, avec prise en charge des versions Open API 1.0, 2.0 et 3.0.

Création de requêtes HTTP OpenAPI

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.

Une fois que vous avez spécifié l'emplacement du document OpenAPI, la fenêtre de test HTTP affiche les chemins disponibles avec les opérations correspondantes.

Opérations OpenAPI disponibles

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.

Test des messages vers l'API OpenAPI

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.