robotframework-jsonlibrary

What it is and what it does

robotframework-jsonlibrary is a Robot Framework test library that bridges Robot Framework to the jsonpath-ng parser, enabling test automation against JSON data structures. It provides keywords to load JSON from files, query values using JSONPath expressions (a syntax similar to XPath for XML), and validate JSON structure and content. The library supports adding, updating, deleting, and retrieving values from JSON objects, as well as validating JSON against schemas.

The package is intended for test automation scenarios where JSON responses or data need to be inspected and manipulated within Robot Framework test cases. It uses JSONPath syntax to navigate and operate on JSON documents. The library has been stable since its initial release but has not received updates in over three years.

Use it for:

• Validate JSON responses from REST APIs in Robot Framework test cases using JSONPath queries
• Extract and assert specific values from nested JSON structures during automated testing
• Validate JSON payloads against JSON Schema definitions within test workflows
• Manipulate test data by adding or updating fields in JSON objects before sending requests
• Load and dump JSON test fixtures from files as part of test setup and teardown

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Robot Framework library for querying, adding, updating, and deleting values in JSON objects using JSONPath expressions.

Yes, if you are actively using Robot Framework for API or JSON-heavy test automation and need JSONPath query support. The library is stable and permissively licensed, but the 1467-day gap since the last release means compatibility with very recent Robot Framework or Python versions should be verified before use.

Install

robotframework-jsonlibrary on PyPI

pip install robotframework-jsonlibrary

uv add robotframework-jsonlibrary

poetry add robotframework-jsonlibrary

Installing robotframework-jsonlibrary

Before you install

High install friction due to the distribution format (tar.gz source archive). The package is dormant—last release was 1467 days ago with no recent maintenance activity, though the repository remains active and marked Production/Stable.

License in practice

Licensed under permissive terms (Public Domain), so there are no licensing restrictions on use or distribution.

Quickstart

pip install robotframework-jsonlibrary

In a Robot Framework test file:
*** Settings ***
Library    JSONLibrary

*** Test Cases ***
Test JSON Manipulation
    ${json_obj}=    Load Json From File    example.json
    ${value}=    Get Value From Json    ${json_obj}    $..country

Robot Framework must be installed separately; the package does not declare it as an explicit dependency in the fact sheet.

Verify before relying

• Whether the package works with modern Robot Framework versions and current Python 3.x releases
• Compatibility with the latest jsonpath-ng parser versions
• Whether Robot Framework is explicitly declared as a dependency or must be pre-installed

Package facts

Evidence: robotframework-jsonlibrary-0.5.tar.gz

Keywords: testing, robotframework, json, jsonschema, jsonpath

Tags

More Testing packages