Implementation of RFC 9535 - JSONPath: Query Expressions for JSON. Reads and writes values in parsed JSON objects using queries like `$.store.book[2].price`.
Package selection guidance compiled from public package information, community data, and project usage.
json_path is a Dart package that implements RFC 9535 for JSONPath, enabling powerful querying and manipulation of JSON data. It allows users to read and write values in parsed JSON objects using expressive path expressions such as `$.store.book[2].price`. The package supports standard JSONPath syntax and is compatible across multiple platforms including Android, iOS, Web, macOS, Windows, and Linux. Ideal for dynamic data extraction and transformation in Flutter applications.
Use cases
Extracting nested JSON values
Updating specific JSON fields
Filtering arrays in JSON data
Parsing complex JSON structures
Dynamic configuration handling
Data transformation in APIs
Key features
Full RFC 9535 compliance
Supports read and write operations
Intuitive path syntax like `$.store.book[2].price`
Cross-platform compatibility
Lightweight and fast
Robust error handling
Suitable for
Flutter apps needing dynamic JSON queries
Backend services processing JSON payloads
Configuration management systems
API clients with variable response structures
Data pipelines requiring flexible JSON manipulation
Considerations
Requires valid JSON input
Performance may vary with deeply nested or large JSON
Limited to JSONPath syntax defined in RFC 9535
Not suitable for non-JSON data types
May need careful validation in untrusted inputs
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
RFC 9535 - JSONPath: Query Expressions for JSON in Dart
JSONPath defines a string syntax for selecting and extracting JSON (RFC 8259) values from within a given JSON value.
This library is a Dart implementation of the RFC 9535 JsonPath specification. It is also expected to pass the latest version
of the Compliance Test Suite. If you find a missing or incorrectly implemented feature, please open an issue.
For installation instructions and a detailed API documentation, see the pub.dev page.
Usage example:
import'dart:convert';
import'package:json_path/json_path.dart';
voidmain() {
final json = jsonDecode('''
{
"store": {
"book": [
{
"category": "reference",
"author": "Nigel Rees",
"title": "Sayings of the Century",
"price": 8.95
},
{
"category": "fiction",
"author": "Evelyn Waugh",
"title": "Sword of Honour",
"price": 12.99
},
{
"category": "fiction",
"author": "Herman Melville",
"title": "Moby Dick",
"isbn": "0-553-21311-3",
"price": 8.99
},
{
"category": "fiction",
"author": "J. R. R. Tolkien",
"title": "The Lord of the Rings",
"isbn": "0-395-19395-8",
"price": 22.99
}
],
"bicycle": {
"color": "red",
"price": 19.95
}
}
}
''');
final prices = JsonPath(r'$..price');
print('All prices in the store:');
/// The following code will print:////// $['store']['book'][0]['price']: 8.95/// $['store']['book'][1]['price']: 12.99/// $['store']['book'][2]['price']: 8.99/// $['store']['book'][3]['price']: 22.99/// $['store']['bicycle']['price']: 19.95
prices
.read(json)
.map((match) => '${match.path}:\t${match.value}')
.forEach(print);
}
Data manipulation
Each JsonPathMatch produced by the .read() method contains the .pointer property which is a valid JSON Pointer
and can be used to alter the referenced value. If you only need to manipulate JSON data,
check out my JSON Pointer implementation.
User-defined functions
The JSONPath parser may be extended with user-defined functions. The user-defined functions
take precedence over the built-in ones specified by the standard. Currently, only
functions of 1 and 2 arguments are supported.
To create your own function:
Import package:json_path/fun_sdk.dart.
Create a class implementing either Fun1 (1 argument) or Fun2 (2 arguments).
To use it:
Create a new JsonPathParser with your function: final parser = JsonPathParser(functions: [MyFunction()]);
Parse the expression: final jsonPath = parser.parse(r'$[?my_function(@)]');
For more details see the included example.
This package comes with a few non-standard functions which you might find useful.
count(<NodeList>) - returns the number of nodes selected by the argument
index(<SingularNodeList>) - returns the index under which the array element is referenced by the parent array
key(<SingularNodeList>) - returns the key under which the object element is referenced by the parent object
is_array(<Maybe>) - returns true if the value is an array
is_boolean(<Maybe>) - returns true if the value is a boolean
is_number(<Maybe>) - returns true if the value is a number
is_object(<Maybe>) - returns true if the value is an object
is_string(<Maybe>) - returns true if the value is a string
reverse(<Maybe>) - returns the reversed string
siblings(<NodeList>) - returns the siblings for the nodes
xor(<bool>, <bool>) - returns the XOR of two booleans arguments
To use them, import package:json_path/fun_extra.dart and pass the functions to the JsonPath() constructor:
final jsonPath = JsonPathParser(functions: [
constKey(),
constReverse(),
]).parse(r'$[?key(@) == reverse(key(@))]');