Points clés
- Catégorie
- Développement et Web
- Types d’entrée
- textarea, text, select, checkbox
- Type de sortie
- html
- Couverture des échantillons
- 4
- API disponible
- Yes
Vue d’ensemble
L'Analyseur sémantique de diff de réponses API compare deux payloads JSON pour isoler les véritables changements fonctionnels du bruit d'exécution (drift). En filtrant automatiquement les variations inoffensives comme les UUID ou les horodatages, cet outil permet aux développeurs et aux équipes QA de valider rapidement les différences entre deux environnements (staging vs production) ou deux versions d'une API, que ce soit en collant des données statiques ou en interrogeant directement des endpoints en direct.
Quand l’utiliser
- •Lors de la migration d'une API vers une nouvelle version pour s'assurer qu'aucune donnée critique n'a été altérée ou supprimée.
- •Pour comparer les réponses entre les environnements de staging et de production avant un déploiement final.
- •Lors de l'exécution de tests de non-régression pour vérifier que les modifications de code n'impactent pas le contrat d'interface.
Comment ça marche
- •Collez les deux réponses JSON à comparer dans les champs de gauche et de droite, ou configurez les URL des endpoints pour effectuer une requête en direct.
- •Définissez les libellés pour chaque environnement (par exemple, 'staging' et 'production') afin de faciliter la lecture des résultats.
- •Activez l'option 'Ignorer les dérives sûres' pour masquer automatiquement les différences liées aux identifiants uniques (UUID) ou aux dates.
- •Lancez l'analyse pour obtenir un rapport visuel mettant en évidence les ajouts, suppressions et modifications de types ou de valeurs.
Cas d’usage
Exemples
1. Comparaison de profils utilisateurs entre Staging et Production
Ingénieur QA- Contexte
- L'équipe QA doit vérifier qu'une mise à jour mineure du backend n'a pas modifié la structure des profils utilisateurs renvoyés par l'API.
- Problème
- Identifier si des champs ont changé de type ou disparu, sans être distrait par les dates de création ou les ID de requête qui changent à chaque appel.
- Comment l’utiliser
- Collez les JSON de réponse dans les champs gauche et droit, nommez les libellés 'Staging' et 'Production', puis activez 'Ignorer les dérives sûres'.
- Configuration d’exemple
-
{ "leftLabel": "Staging", "rightLabel": "Production", "ignoreSafeDrift": true, "useAiSemanticReview": true } - Résultat
- L'outil masque les différences d'UUID et d'horodatage, mais met en évidence que le champ 'quota' est passé d'un entier à une chaîne de caractères en production.
2. Vérification en direct de la rétrocompatibilité d'une API v2
Développeur Backend- Contexte
- Un développeur a réécrit un endpoint de recherche (v2) et veut s'assurer qu'il renvoie les mêmes résultats que l'ancienne version (v1) pour une même requête.
- Problème
- Comparer dynamiquement les réponses de deux endpoints distincts sans avoir à copier-coller manuellement les payloads JSON.
- Comment l’utiliser
- Renseignez les URL des endpoints v1 et v2, définissez la méthode sur POST, ajoutez le JSON du body de la requête, et lancez l'analyse.
- Configuration d’exemple
-
{ "leftEndpointUrl": "https://api.example.com/v1/search", "rightEndpointUrl": "https://api.example.com/v2/search", "httpMethod": "POST", "requestBodyJson": "{\"query\": \"test\"}" } - Résultat
- L'outil exécute la requête sur les deux URL, récupère les JSON et affiche un diff sémantique confirmant que la structure des résultats est identique.
Tester avec des échantillons
jsonHubs associés
FAQ
Qu'est-ce que le 'drift' dans une réponse API ?
Le drift (ou dérive) correspond aux variations normales et inoffensives entre deux requêtes identiques, comme les identifiants de session, les UUID générés dynamiquement ou les horodatages (timestamps).
Puis-je comparer directement deux URL d'API ?
Oui, vous pouvez renseigner les URL des endpoints gauche et droit, ainsi que la méthode HTTP et les en-têtes, pour que l'outil interroge directement les API avant de comparer les JSON retournés.
À quoi sert l'option de revue sémantique par IA ?
Cette option affine l'analyse en utilisant un modèle d'intelligence artificielle pour mieux distinguer les véritables changements de contrat des variations de données complexes ou ambiguës.
L'outil détecte-t-il les changements de type de données ?
Oui, l'analyseur parcourt récursivement la structure JSON et signale si un champ est passé, par exemple, d'un entier à une chaîne de caractères.
Mes données JSON sont-elles stockées ?
Non, l'analyse est effectuée à la volée pour générer le rapport de différences, et les payloads fournis ne sont pas conservés au-delà du traitement de votre requête.