ToolRobinSans connexion, utilisable immédiatement

Vérificateur de compatibilité OpenAPI

Comparez localement deux spécifications OpenAPI 3.x et examinez les modifications potentiellement rompues du contrat d'API par opération et chemin de champ.

Collez ou choisissez les fichiers OpenAPI 3.0, 3.1 ou 3.2 originaux et révisés. Vérifiez la gravité et le chemin du champ concerné, puis téléchargez un rapport Markdown ou JSON pour examen.

Comparez deux fichiers OpenAPI avant la publication. Les spécifications restent dans ce navigateur.

Collez JSON ou YAML ci-dessous, ou choisissez un fichier.
Collez JSON ou YAML ci-dessous, ou choisissez un fichier.

Chaque fichier : jusqu'à 2 Mo et 1 000 opérations. Prend en charge OpenAPI 3.0, 3.1 et 3.2.

Comment utiliser

Examiner les modifications d'OpenAPI avant de publier une API

Comparez localement deux spécifications OpenAPI 3.x et examinez les modifications potentiellement rompues du contrat d'API par opération et chemin de champ.

Étapes à suivre

  1. Fournissez la source avec : Spécification originale / Spécification révisée.
  2. Lancez : Vérifier la compatibilité. Examinez le résultat avant de le copier, télécharger ou utiliser ailleurs.
  3. Collez ou choisissez les fichiers OpenAPI 3.0, 3.1 ou 3.2 originaux et révisés. Vérifiez la gravité et le chemin du champ concerné, puis téléchargez un rapport Markdown ou JSON pour examen.

Choisir les réglages

OptionCe qui change
Spécification originaleLes références au sein d'un fichier de spécifications sont suivies. Les références de fichiers ou d'URL externes ne sont pas récupérées et apparaissent comme résultats d'examen. Les schémas récursifs sont comparés dès leur première occurrence et marqués pour examen.
Vérifier la compatibilitéLe vérificateur compare les opérations, les paramètres, les corps de requête, les codes de réponse et les types de médias, ainsi que les modifications de schéma courantes telles que les propriétés supprimées, les propriétés de requête nouvellement requises, les modifications de type et les valeurs d'énumération. Les résultats incluent l’opération concernée et le chemin de champ.

Exemple et résultat attendu

Si la réponse GET /users/{id} révisée rend obligatoire un champ `email` facultatif, le rapport signale le contrat de réponse modifié. Les références locales `$ref` sont suivies ; les références externes et la composition de schémas complexes sont appelées à être examinées manuellement. Il ne s'agit pas d'un validateur de spécifications complètes ni d'un test de l'API en cours d'exécution.

Si cela ne fonctionne pas

  • Le résultat est une revue de contrat statique, et non un validateur de conformité OpenAPI complet, un test d'API d'exécution ou un audit de sécurité. Le comportement du serveur, la logique d'autorisation et la composition de schémas complexes peuvent nécessiter un examen manuel. Le rapport indique quelles références ou structures récursives n'ont pas été entièrement vérifiées.
  • Si l’analyse échoue, vérifiez la syntaxe JSON ou YAML avant les résultats API. Placez les références locales nécessaires dans le même document. Les références externes non résolues et les schémas non pris en charge exigent une revue manuelle ; l’outil ne les télécharge pas et ne teste pas de serveur.

Quels changements sont vérifiés ?

Le vérificateur compare les opérations, les paramètres, les corps de requête, les codes de réponse et les types de médias, ainsi que les modifications de schéma courantes telles que les propriétés supprimées, les propriétés de requête nouvellement requises, les modifications de type et les valeurs d'énumération. Les résultats incluent l’opération concernée et le chemin de champ.

Comment sont gérées les références ?

Les références au sein d'un fichier de spécifications sont suivies. Les références de fichiers ou d'URL externes ne sont pas récupérées et apparaissent comme résultats d'examen. Les schémas récursifs sont comparés dès leur première occurrence et marqués pour examen.

Qu'y a-t-il en dehors de ce contrôle ?

Le résultat est une revue de contrat statique, et non un validateur de conformité OpenAPI complet, un test d'API d'exécution ou un audit de sécurité. Le comportement du serveur, la logique d'autorisation et la composition de schémas complexes peuvent nécessiter un examen manuel. Le rapport indique quelles références ou structures récursives n'ont pas été entièrement vérifiées.

Vous pourriez également avoir besoin