Comment utiliser : Validateur OpenAPI / Swagger
- Collez votre
openapi.yaml/swagger.jsonou ouvrez le fichier. - La version (OpenAPI 3.1, 3.0 ou Swagger 2.0) est détectée automatiquement.
- Corrigez d'abord les erreurs de schéma : chacune indique son emplacement dans le document.
- Consultez les contrôles supplémentaires et la liste des endpoints.
Ce qui est vérifié
| Contrôle | Détails |
|---|---|
| Schéma officiel | Le document est validé par rapport au JSON Schema de l'OpenAPI Initiative pour sa version (3.1, 3.0 ou Swagger 2.0) : champs obligatoires, clés autorisées, types de valeurs |
$ref cassée | Chaque référence locale (#/components/schemas/Pet) doit pointer vers un élément existant |
operationId unique | Les doublons perturbent les générateurs de SDK et les liens de la documentation |
| Paramètres de chemin | Chaque {param} d'un chemin doit être déclaré avec in: path et required: true, et inversement |
| Réponses | Chaque opération doit comporter au moins une réponse |
| Suggestions | operationId, servers ou info.description manquants |
Versions d'OpenAPI
- Swagger 2.0 —
swagger: "2.0",definitions,host/basePath. - OpenAPI 3.0 —
components,servers,requestBody; les schémas reprennent un sous-ensemble du brouillon 4 de JSON Schema avecnullable. - OpenAPI 3.1 — entièrement aligné sur JSON Schema 2020-12 (
type: [string, "null"]à la place denullable), ajoutewebhooks.
Limites
Les références externes vers d'autres fichiers ou URL ne sont pas récupérées : regroupez d'abord les spécifications réparties sur plusieurs fichiers (par exemple avec redocly bundle). La validation de schéma signale les problèmes structurels ; les règles de style, comme les conventions de nommage, nécessitent un linter comme Spectral. Pour valider vos exemples de données avec vos schémas, utilisez le validateur JSON Schema, vérifiez la syntaxe YAML avec le validateur YAML, et testez l'API en conditions réelles avec le testeur d'API.
Aussi recherché comme : validateur swagger, validateur openapi, valider openapi, validateur openapi 3.1, validateur swagger 2.0, lint openapi, vérifier spec api.
Outils complémentaires : Validateur OpenAPI / Swagger
- Formateur JSON — Collez votre code JSON pour le formater, le compresser ou le valider.
- cURL vers code — Collez une commande curl, issue de la documentation d’une API ou de l’option « Copier en tant que cURL » des outils de développement de votre navigateur, et obtenez du code prêt à l’emploi pour six langages, avec les en-têtes, le corps de requête et l’authentification repris à l’identique.
- Testeur JSONPath — Saisissez une requête JSONPath et voyez immédiatement ce qu'elle sélectionne, avec le chemin exact de chaque résultat.
- JSON vers YAML — Collez du JSON et obtenez un YAML propre pour vos manifestes Kubernetes, Docker Compose, GitHub Actions ou tout autre fichier de configuration.
Questions fréquentes
Le validateur prend-il en charge OpenAPI 3.1 ?
Oui : OpenAPI 3.1.x, 3.0.x et Swagger 2.0 sont chacun validés par rapport à leur schéma officiel.
Pourquoi une seule erreur en produit-il autant ?
Les schémas officiels utilisent des alternatives (oneOf), si bien qu'une seule valeur incorrecte peut faire échouer plusieurs branches. L'outil filtre ces messages pour ne garder que les plus précis ; corrigez le premier et relancez la vérification.
Peut-il suivre les $ref vers d'autres fichiers ?
Non, seulement les références à l'intérieur du même document. Regroupez d'abord les spécifications réparties sur plusieurs fichiers en un seul.
Ma spécification d'API est-elle envoyée sur un serveur ?
Non. La validation s'effectue entièrement dans votre navigateur, de sorte que vos conceptions d'API internes restent confidentielles.
Puis-je installer Validateur OpenAPI / Swagger en tant qu’application web et l’utiliser hors ligne ?
Oui. Validateur OpenAPI / Swagger est une application web installable (PWA) : elle s’installe depuis votre navigateur, sans passer par une boutique d’applications. Cliquez sur « Installer l’application » en haut de cette page dans Chrome ou Edge (Windows, macOS, Linux, ChromeOS) ; sur Android, utilisez « Partager » → « Ajouter à l’écran d’accueil » sur iPhone et iPad ; ou « Fichier » → « Ajouter au Dock » dans Safari 17+ sur Mac. L’application s’ouvre alors dans sa propre fenêtre avec sa propre icône, et comme elle s’exécute entièrement dans votre navigateur, elle continue de fonctionner hors ligne. Firefox sur ordinateur de bureau ne permet pas d’installer d’applications web. Comment fonctionne l’installation.