Qu'est-ce qu'OpenAPI/Swagger ?
OpenAPI (anciennement Swagger) est la spécification standard de l'industrie pour décrire les API RESTful. Un document OpenAPI définit vos points de terminaison d'API, vos formats de requête et de réponse, vos méthodes d'authentification et vos schémas de données dans un fichier YAML ou JSON lisible par machine. Il est largement utilisé pour la documentation des API, la génération de SDK client et les tests automatisés.
Comment utiliser cette visionneuse OpenAPI
- 1Collez votre spécification OpenAPI 3.x au format YAML ou JSON dans la zone de texte.
- 2L'outil analyse et affiche automatiquement les informations sur l'API, les points de terminaison et les schémas.
- 3Cliquez sur n’importe quel point de terminaison pour développer les détails, notamment les paramètres, le corps de la demande et les codes de réponse.
- 4Utilisez la barre de filtre pour rechercher des points de terminaison par chemin, méthode, résumé ou balise.
- 5Cliquez sur un nom de schéma pour afficher ses propriétés et ses champs obligatoires.
Cas d'utilisation courants
Examen rapide de la documentation de l'API
Visualisez une spécification d'API sans exécuter un serveur d'interface utilisateur Swagger complet.
Validation du schéma
Vérifiez que vos modèles de données et définitions de points de terminaison sont corrects avant de générer du code client.
Collaboration en matière de conception d'API
Partagez et révisez les conceptions d'API en collant des spécifications lors des révisions de code ou des réunions de planification.
Questions fréquentes
Est-ce que cela prend en charge OpenAPI 2.0 (Swagger) ?
Cette visionneuse est optimisée pour OpenAPI 3.x. Les spécifications Swagger 2.0 peuvent fonctionner partiellement mais certains champs comme consomme/produit ne sont pas rendus.
Ma spécification API est-elle envoyée à n’importe quel serveur ?
Non. L’analyse et le rendu s’effectuent entièrement dans votre navigateur. Aucune donnée ne quitte votre machine.
Puis-je importer à partir d'une URL ?
Actuellement, vous devez coller directement le contenu des spécifications. Copiez le YAML/JSON brut de votre fichier ou de votre URL et collez-le ici.