Aller au contenu

Validateur OpenAPI

Vérifiez un document OpenAPI 3.0, 3.1, 3.2 ou Swagger 2.0 au format YAML ou JSON et obtenez un résumé de ses points de terminaison et de ses schémas. Le validateur vérifie les champs obligatoires, la correspondance entre les modèles de chemin et les paramètres de chemin, l’emplacement des paramètres, les codes de réponse, les identifiants d’opération en double et chaque $ref local. Il indique l’emplacement de chaque problème.

Réinitialiser

Foire aux questions

Que vérifie le validateur ?

Il vérifie la version openapi ou swagger, info.title et info.version, que les chemins commencent par une barre oblique, que chaque {parameter} dans un chemin a un paramètre de chemin obligatoire correspondant, et inversement, ainsi que les noms et emplacements des paramètres, les codes d’état et descriptions des réponses, les paramètres en double, les valeurs operationId en double et le fait que chaque $ref local pointe vers un élément du document.

S’agit-il d’une validation complète de la spécification par le schéma JSON ?

Non. Il vérifie les règles structurelles ci-dessus, qui détectent la plupart des erreurs dans les documents rédigés à la main, mais ne valide pas chaque champ par rapport au méta-schéma officiel et ne vérifie pas le contenu de vos schémas.

Que contient le résumé ?

La spécification et la version API, le titre, un tableau de tous les points de terminaison avec leur méthode, chemin, operationId, résumé et codes de réponse, ainsi que les noms des schémas sous components.schemas ou, pour Swagger 2.0, sous definitions.

Les références externes sont-elles suivies ?

Non. Les références vers d’autres fichiers ou URL ne sont ni récupérées ni signalées. Seules les références commençant par # sont résolues dans le document collé.

Quelle est la différence entre les erreurs et les avertissements ?

Les erreurs enfreignent une règle de la spécification, par exemple une description de réponse manquante ou un paramètre de chemin non déclaré. Les avertissements signalent des éléments autorisés, mais généralement involontaires, comme une opération GET avec un corps de requête ou un document sans aucun operationId.

OpenAPI 3.1 change-t-il les éléments obligatoires ?

Oui. Dans OpenAPI 3.1 et 3.2, une opération n’a plus besoin d’un objet responses, et un document peut contenir des webhooks ou des components à la place de paths. Le validateur applique ces règles lorsque le champ openapi commence par 3.1 ou 3.2.

À propos de OneClick Pro

OneClick Pro est une collection gratuite de plus de 150 outils Web pour les tâches du quotidien : convertir des images et des unités, formater et valider du code, vérifier des domaines et SEO, et travailler avec du texte, des dates et des nombres. Chaque outil fonctionne sans inscription ni abonnement, et les données saisies servent uniquement à calculer le résultat et ne sont jamais stockées. Utilisez cette boîte à outils pour des tâches ponctuelles ou ajoutez à vos favoris les outils dont vous vous servez chaque jour.