Visionneuse OpenAPI / Swagger

Générez la documentation d’un document OpenAPI 3.0 / 3.1 ou Swagger 2.0 (YAML ou JSON) sous forme de référence d’API consultable — informations, serveurs, chemins regroupés par étiquette, paramètres, exemples de corps de requête générés à partir des schémas, réponses et sécurité. Développez une opération pour Essayer et envoyer une requête réelle depuis votre navigateur, ou exportez-la en cURL. Les documents sont analysés localement ; les cibles distantes $ref et les schémas externes ne sont pas récupérés (entièrement local). Vous préférez un compositeur de requêtes interactif ? Voir le client / testeur d’API REST et l’ensemble des outils API.
Essayer
Paramètres
À propos de cette visionneuse : prend en charge Swagger 2.0 et OpenAPI 3.0 / 3.1. Les références sont résolues uniquement à l’intérieur du document (#/components/schemas/…, #/definitions/…) ; les références à un fichier ou une URL externe sont signalées et non récupérées. Les appels « Essayer » sont soumis à la politique CORS du serveur cible — si un appel est bloqué, utilisez le convertisseur cURL ou le client REST pour l’exécuter hors du bac à sable du navigateur.
OpenAPI et Swagger, v2 et v3

Swagger était le nom initial de l’outillage ; lorsque le format de spécification a été confié à la Linux Foundation en 2015, il est devenu OpenAPI, et Swagger demeure une marque d’outillage. Un document se compose de info (métadonnées), paths (opérations par point de terminaison) et components (schémas réutilisables).

La clé de version indique aux visionneuses quel analyseur utiliser : swagger: "2.0" contre openapi: 3.0.x — la v3 a sorti les corps de requête des paramètres et adopté un vrai JSON Schema.