Overview

This manual is divided into several sections, each focusing on a specific aspect of interacting with JSON data using the JSON Operations Library.

Introduction

The JSON Operations Library provides a comprehensive set of tools for manipulating JSON data. This library allows users to perform a wide range of operations on JSON objects, including retrieving specific elements, converting between JSON and strings, modifying JSON data, comparing JSON objects, and creating or merging JSON objects. This section provides an overview of the JSON Operations Library and outlines the prerequisites for using it effectively.

Prerequisites for Using the JSON Operations Library

Before you can start using the JSON you need a:

Basic Understanding of JSON: Familiarity with JSON (JavaScript Object Notation) structure and syntax is essential. JSON is a lightweight data interchange format that is easy for humans to read and write and easy for machines to parse and generate.

Getting Data from JSON

Retrieving Specific Elements

To retrieve specific elements from a JSON object, you can use the following commands:

Get a specific element from JSON

get the json
get the json's name

get the json
get the json's first name

get the json
get the json's address city

These commands allow you to access nested elements within a JSON object by specifying the path to the desired element.

Converting JSON to String and Vice Versa

Convert JSON to a String

To convert a JSON object to a string, use the following command:

get the json
get the json as a string

Convert a String to JSON

To convert a string to a JSON object, use the following commands:

get the string
get the string as json

the string is '{"name":"John", "age":30, "city":"New York"}'
get the string as json

These commands facilitate the conversion between JSON objects and strings, enabling easy data interchange and manipulation.

Modifying JSON

Setting or Changing Values

To set or change a value in a JSON object, use the following commands:

get the json
the json's age is 23

get the json
set the json's name to "John Doe"

get the json
change the json's "settings.notifications.enabled" to false

Deleting a Key

To delete a key from a JSON object, use the following command:

get the json
delete the json's username

These commands allow you to modify JSON objects by setting, changing, or deleting specific keys and their values.

Comparing JSON Objects

Compare Two JSON Objects

To compare two JSON objects, use the following commands:

set the target to
    {
        "name": "John",
        "age": 30,
        "city": "New York"
    }
set the object to
    {
        "name": "John",
        "age": 31,
        "city": "New York"
    }
compare the target json with the object json

set the target to
    {
        "product": "Laptop",
        "price": 1200,
        "specs": {
            "RAM": "16GB",
            "Storage": "512GB SSD"
        }
    }
set the object to
    {
        "product": "Laptop",
        "price": 1200,
        "specs": {
            "RAM": "8GB",
            "Storage": "256GB SSD"
        }
    }
compare the target json with the object json

These commands enable you to compare two JSON objects and identify differences between them.

Creating and Merging JSON Objects

Creating an Empty JSON Object

To create an empty JSON object, use the following command:

create a json

Merging Two JSON Objects

To merge two JSON objects, use the following command:

merge the target json with the object json

In case of duplicate keys, the value from the object JSON will be used. For example:

Example
target json
    {
        "name": "John",
        "age": 30
    }
object json
    {
        "place": "USA",
        "age": 31
    }
final result json
    {
        "name": "John",
        "place": "USA"
        "age": 31
    }

These commands allow you to create new JSON objects and merge existing ones, combining their data as needed.

Glossary of Terms

JSON (JavaScript Object Notation): A lightweight data interchange format that is easy for humans to read and write and easy for machines to parse and generate.
JSON Object: A collection of key-value pairs enclosed in curly braces {}. Each key is a string, and each value can be a string, number, boolean, array, or another JSON object.
JSON String: A string representation of a JSON object, often used for data interchange between systems.

By following these guidelines, you can effectively manage JSON data using the JSON Operations Library, from retrieving and converting data to modifying, comparing, creating, and merging JSON objects.