Testeur JSONPath

JSONPath est un langage de requête pour JSON qui vous permet d'écrire des expressions concises pour sélectionner, filtrer et extraire des données à partir de structures JSON imbriquées sans écrire de boucles ni de logique conditionnelle. Vous devez utiliser JSONPath lorsque vous devez configurer des règles d'extraction de données dans des fichiers externes, des outils ou des spécifications déclaratives plutôt que de les coder en dur dans votre application. Les cas d'utilisation courants incluent: la configuration des transformations de réponse API Gateway (comme les modèles de mappage AWS API Gateway), l'écriture de règles d'extraction de données pour les pipelines ETL où les analystes métier peuvent écrire des expressions JSONPath, la mise en œuvre d'un filtrage dynamique dans les outils de tableau de bord et de reporting, la sélection d'appareils de données de test à partir de JSON complexes dans des tests automatisés et la création d'outils low-code/no-code où les utilisateurs spécifient des extractions de données sans codage. Les bibliothèques de langages de programmation compilent les expressions JSONPath au moment de l'exécution, ce qui vous permet d'obtenir une extraction de données dynamique et configurable sans redéploiement.

Les expressions JSONPath de base commencent par $ (root), utilisez .clé pour l'accès enfant à l'objet ($..magasin.livre[0].titre accède au premier titre de livre dans n'importe quel magasin), utilisez [n] pour l'indexation de tableau, utilisez [ * ] pour les caractères génériques de tableau et utilisez .. pour la descente récursive (trouver tous les champs de titre à n'importe quel niveau d'imbrication). Les expressions avancées incluent des prédicats de filtre [@.prix > 10 pour filtrer les tableaux par conditions], découpage de tableau [0:5: 2 pour début: fin: étape], opérateurs d'union [0,2,4 pour plusieurs indices], fonctions de longueur pour obtenir la taille des tableaux et notation entre crochets ['key'] pour les clés qui contiennent des caractères spéciaux ou des espaces. Par exemple:$.magasin.livre[?(@.prix < 10)].titre sélectionne les titres des livres de moins de 10 $et $..[?(@.category = = fiction)] sélectionne tous les objets avec un champ de catégorie égal à fiction à n'importe quel niveau d'imbrication.

JSONPath est inspiré de XPath (pour XML) mais simplifié pour le modèle de données plus simple de JSON: JSONPath utilise $ pour root au lieu de XPath /, utilise .clé au lieu de l'axe enfant XPath /key, prend en charge .. pour une descente récursive similaire à / / de XPath, et inclut des expressions de filtre similaires aux prédicats de XPath. Le pointeur JSON (RFC 6901) est une norme beaucoup plus simple qui identifie une seule valeur spécifique dans un document JSON à l'aide des index /separated/keys/et/0/array/. Contrairement à JSONPath qui peut renvoyer plusieurs valeurs et filtrer les résultats, le pointeur JSON renvoie toujours exactement une valeur ou échoue. JSONPath est le bon choix lorsque vous devez extraire plusieurs valeurs correspondantes, naviguer de manière récursive, filtrer les résultats ou spécifier dynamiquement des requêtes. Le pointeur JSON est plus simple et approprié lorsque vous identifiez de manière unique une valeur spécifique (comme dans les opérations de patch JSON ou les références OpenAPI $ref).

Oui, les bibliothèques JSONPath sont disponibles pour la plupart des principaux langages de programmation. Les implémentations notables incluent: Jayway JSONPath pour Java (l'implémentation la plus complète en fonctionnalités, largement utilisée via Spring Boot), jsonpath - ng et jsonpath-python pour Python, JSONPath Plus pour JavaScript (Nœud.js et navigateur, utilisés par cet outil), GoJSONGo pour Go, rust-jsonpath pour Ruby et JSON:: Path pour Perl. La plupart des implémentations suivent la même syntaxe mais présentent de subtiles différences dans la prise en charge des expressions de filtre, le comportement de descente récursive et la gestion des cas limites. Lors du portage des expressions JSONPath entre les langages, testez minutieusement car les expressions de filtrage avec des conditions complexes peuvent se comporter différemment. Certaines implémentations sont plus proches de la spécification Goessner d'origine tandis que d'autres suivent le nouveau projet de norme IETF RFC 9535 pour JSONPath qui a été publié en février 2024.

Les causes courantes des résultats JSONPath vides incluent: traversée de chemin incorrecte (vérifiez que chaque niveau de votre chemin existe dans le document), sensibilité à la casse (les clés JSON sont sensibles à la casse, le nom est différent du nom), étapes de descente récursives manquantes (utilisez .. si vous ne connaissez pas la profondeur d'imbrication exacte), des index de tableau incorrects (les tableaux JSON sont indexés à zéro, donc [0] est le premier élément), des guillemets manquants dans la notation entre crochets( devrait être ['key'] pas [key]), des erreurs de syntaxe d'expression de filtre (utilisez @ not $ pour référencer le nœud actuel dans les filtres) et le nœud de résultat étant nul ou indéfini (JSONPath peut ignorer les nœuds nuls dans certaines implémentations). Commencez par simplifier votre expression en un chemin de base et vérifiez qu'elle renvoie des résultats, puis ajoutez progressivement de la complexité. Utilisez l'arborescence de notre testeur pour vérifier que la structure du document correspond à ce que vous attendez avant de créer des expressions complexes.