Skip to content

A powerful .NET library for evaluating string-based predicate expressions against JSON objects using JSONPath syntax.

License

Notifications You must be signed in to change notification settings

CodeShayk/JSONPathPredicate

Repository files navigation

ninja JSONPathPredicate v1.1.0

NuGet version License: MIT GitHub Release master-build master-codeql .Net 9.0 .Net Framework 4.6.4 .Net Standard 2.0

A powerful .NET library for evaluating string-based predicate expressions against JSON objects using JSONPath syntax.

Features

  • JSONPath Support: Access nested object properties using dot notation
  • Multiple Operators: eq (equal), in (contains), not (not equal), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal)
  • Logical Operators: and, or with proper precedence handling
  • Type Safety: Automatic type conversion and validation
  • Complex Expressions: Parentheses grouping and nested operations
  • Lightweight: Minimal dependencies, fast evaluation

Installation

Install via NuGet Package Manager:

Install-Package JsonPathPredicate

Getting Started

The library provides a powerful, flexible way to evaluate complex conditional logic against JSON objects, making it ideal for business rules, filtering, validation, and many other use cases in .NET applications.

Please see wiki for comprehensive documentation to integrate JSONPathPredicate in your project.

i. Expression Syntax

The expression syntax is ([JSONPath] [Comparison Operator] [Value]) [Logical Operator] ([JSONPath] [Comparison Operator] [Value])

ii. Supported Operators

  • Comparison Operators - eq, in, gt, gte, lt, lte & Not
  • Logical Operators - and & or

Example

var customer = new {
    client = new {
        address = new {
            postcode = "e113et",
            number = 123,
            active = true
        },
        tags = new[] { "vip", "premium" }
    },
    score = 95.5
};

i. Simple equality

bool result1 = JSONPredicate.Evaluate("client.address.postcode eq `e113et`", customer);

ii. Logical operators

bool result2 = JSONPredicate.Evaluate("client.address.postcode eq `e113et` and client.address.number eq 123", customer);

iii. Array operations

bool result3 = JSONPredicate.Evaluate("client.tags in [`vip`, `standard`]", customer);

Contributing

  • Fork the repository
  • Create your feature branch (git checkout -b feature/AmazingFeature)
  • Commit your changes (git commit -m 'Add some AmazingFeature')
  • Push to the branch (git push origin feature/AmazingFeature)
  • Open a Pull Request

License

This project is licensed under the MIT License - see the license file for details.

Support

  • 📖 Read the Documentation
  • 🐛 If you are having problems, please let us know by raising a new issue here.
  • 💬 Ask questions on Discussions