Afficher une définition OpenAPI ou Swagger en local

Collez une définition autonome pour parcourir opérations, corps de requête, réponses et schémas sans l’envoyer nulle part. La visionneuse vérifie la version et résout chaque référence à l’intérieur du document collé avant l’affichage.

VISIONNEUR LOCALSwagger UI 5.32.14OpenAPI 3.x · Swagger 2.0Exécution des endpoints désactivée
Votre définition est rendue dans ce navigateur. Chaque $ref doit se résoudre à l’intérieur du document collé ; les URL externes, les chemins de fichier relatifs, les appels de validation et les requêtes Try it out sont bloqués, et aucune requête ne quitte le navigateur.
Document OpenAPI ou Swagger
Aperçu de la documentation
Collez un document OpenAPI ou Swagger, puis lancez le rendu de la documentation locale.

Relire la documentation sans activer de client API

Cette visionneuse sert à relire le contrat visuellement : elle n’envoie aucune requête, ne conserve aucune autorisation, ne télécharge aucune définition distante et ne résout aucune référence extérieure au document collé. Utilisez l’Explorer lorsque vous voulez générer une requête à partir de détails d’API copiés.

Comment afficher une définition d’API en local

Collez une définition OpenAPI 3.x ou Swagger 2.0 et lisez-la comme documentation Swagger UI sans l’envoyer nulle part. L’analyse, la vérification et l’affichage se font dans cet onglet, Try it out est désactivé et le nombre de requêtes mesuré pendant l’affichage reste à zéro.

La visionneuse vérifie d’abord la définition. La racine doit porter une version prise en charge, chaque $ref doit pointer à l’intérieur du même document, et toutes ces références doivent se résoudre ; tout autre cas est signalé dans la ligne d’état au lieu de laisser une page à moitié rendue.

  1. Collez une définition JSON ou YAML, ou cliquez sur Charger un exemple pour une API de notes à deux opérations.
  2. Cliquez sur Afficher la documentation locale. Le JSON et le YAML sont lus dans le navigateur ; un problème YAML indique la ligne, un problème JSON indique la position.
  3. Dépliez une opération pour lire paramètres, corps de requête, réponses et schémas. Ici, les opérations ne sont que de la documentation : aucun bouton de requête n’est affiché.
  4. Effacer vide le champ et l’aperçu. Après un rendu, modifier le document atténue l’aperçu et le marque comme appartenant au document précédent jusqu’au prochain rendu.

Ce que la visionneuse vérifie avant l’affichage

Ce que la définition peut contenir

Les racines OpenAPI 3.x et Swagger 2.0 sont acceptées ; le champ de version est obligatoire et openapi: 4.x est refusé par un message au lieu d’une page d’erreur de Swagger UI. Le JSON et le sous-ensemble YAML utilisé par les fichiers OpenAPI sont lus : mappings, séquences, collections en ligne [] et {}, clés entre guillemets, commentaires, scalaires de bloc | et > avec chomping, ancres et alias (&nom / *nom) et balises !!str, !!int, !!float, !!bool et !!null. Un second document après --- est signalé comme une erreur au lieu d’être fusionné avec le premier.

Références et requêtes réseau

Seules les références internes au document collé sont prises en charge. ./schemas/a.json, a.yaml, les chemins relatifs et les URL http(s) sont refusés avant l’affichage, et le message nomme la propriété qui les porte : une définition qui pointe vers un fichier relatif est donc signalée au lieu d’être demandée silencieusement à ce site. Les références locales comme #/components/schemas/Note sont résolues contre le document collé, et une référence vers un nœud absent est signalée tout de suite au lieu d’échouer au dépliage de l’opération.

Lire le résultat

L’aperçu liste les opérations avec leurs paramètres, corps de requête, réponses et schémas dans la mise en page de base de Swagger UI, sans bouton Try it out ni formulaire d’autorisation. Mesuré sur cette version : l’exemple fourni affiche deux opérations, une définition de 200 opérations prend environ un quart de seconde et afficher deux fois le même document ne duplique pas l’aperçu.

Outils récents :