Validation of JSON array items

Question

Validation of JSON array items

I am in need of a tool that can validate JSON data with specific examples. Here is the JSON fragment:

{
    "optionsMinValue": 0
    "optionsMaxValue": 56
    "options": [
        {
            "name": "name1",
            "value": 0
        },
        {
            "name": "name2",
            "value": 1
        },
        {
            "name": "name3",
            "value": 56
        }
  ]
}

Specific validation cases:

When analyzing the above fragment, the validation for optionsMaxValue must pass.
If the optionsMaxValue is altered to 55 in the given fragment, then the validation should return an error.

Bonus validation criterion:

There must be an item in the options array for every whole number between optionsMinValue and optionsMaxValue. In this case, there should be 57 items in the array corresponding to values from 0 to 56.

Current tools available:

Are there any tools readily available to efficiently carry out these validations?

Initially, I thought about utilizing json-schema validation. However, it has been quite some time since I explored that option, so I am hopeful that more advanced tools have been developed for this purpose.

json validation

Answer 1

Answer №1

Ajv JSON schema validator - click here for the GitHub link

const schema = {
  type: "object",
  properties: {
    name: {type: "string"},
    value: {type: "number", minimum: 0, maximum: 55},
  },
  required: ["name", "value"],
  additionalProperties: false,
}

const option = {
    "name": "exampleName",
    "value": 10
},

const validate = ajv.compile(schema)
const valid = validate(data)
if (!valid) console.log(validate.errors)

<script src="https://cdnjs.cloudflare.com/ajax/libs/ajv/4.4.0/ajv.min.js"></script>

Answer 2

Ajv JSON schema validator - click here for the GitHub link

const schema = {
  type: "object",
  properties: {
    name: {type: "string"},
    value: {type: "number", minimum: 0, maximum: 55},
  },
  required: ["name", "value"],
  additionalProperties: false,
}

const option = {
    "name": "exampleName",
    "value": 10
},

const validate = ajv.compile(schema)
const valid = validate(data)
if (!valid) console.log(validate.errors)

<script src="https://cdnjs.cloudflare.com/ajax/libs/ajv/4.4.0/ajv.min.js"></script>

Answer 3

Answer №2

Utilizing the Joi package is highly recommended for conducting these specific validations.

The following Joi schema can be applied to address your particular requirements:

Joi.object({
  optionsMinValue: Joi.number().min(0).max(30).required(),

  optionsMaxValue: Joi.number().min(56).max(100).required(),

  options: Joi.array().items(
    Joi.object({
      name: Joi.string().required(),
      value: Joi.number().min(0).max(56).required(),
    })
  ),
});

Here is a code snippet that effectively addresses your use case:

const inputData = {
  optionsMinValue: 0,
  optionsMaxValue: 56,
  options: [
    {
      name: "name1",
      value: 0,
    },
    {
      name: "name2",
      value: 1,
    },
    {
      name: "name3",
      value: 56,
    },
  ],
};

const Joi = joi; // for node.js use - const Joi = require("joi");

// Schema for validation
const schema = Joi.object({
  optionsMinValue: Joi.number().min(0).max(30).required(),

  optionsMaxValue: Joi.number().min(56).max(100).required(),

  options: Joi.array().items(
    Joi.object({
      name: Joi.string().required(),
      value: Joi.number().min(0).max(56).required(),
    })
  ),
});

const runValidation = (schema, inputData) => {
  const validationResult = Joi.compile(schema)
    .prefs({ errors: { label: "key" }, abortEarly: false })
    .validate(inputData);

  if (validationResult.error) {
    // Validation failed
    console.log("Error, validation failed");
    // Set error message to string
    const errorMessage = validationResult.error.details
      .map((details) => details.message)
      .join(", ");
    console.log("failure reason - ", errorMessage);
    return;
  }
  console.log("validation passed");
};
runValidation(schema, inputData);

<script src="https://cdn.jsdelivr.net/npm/<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="452f2a2c0574726b736b75">[email protected]</a>/dist/joi-browser.min.js"></script>

Answer 4

Utilizing the Joi package is highly recommended for conducting these specific validations.

The following Joi schema can be applied to address your particular requirements:

Joi.object({
  optionsMinValue: Joi.number().min(0).max(30).required(),

  optionsMaxValue: Joi.number().min(56).max(100).required(),

  options: Joi.array().items(
    Joi.object({
      name: Joi.string().required(),
      value: Joi.number().min(0).max(56).required(),
    })
  ),
});

Here is a code snippet that effectively addresses your use case:

const inputData = {
  optionsMinValue: 0,
  optionsMaxValue: 56,
  options: [
    {
      name: "name1",
      value: 0,
    },
    {
      name: "name2",
      value: 1,
    },
    {
      name: "name3",
      value: 56,
    },
  ],
};

const Joi = joi; // for node.js use - const Joi = require("joi");

// Schema for validation
const schema = Joi.object({
  optionsMinValue: Joi.number().min(0).max(30).required(),

  optionsMaxValue: Joi.number().min(56).max(100).required(),

  options: Joi.array().items(
    Joi.object({
      name: Joi.string().required(),
      value: Joi.number().min(0).max(56).required(),
    })
  ),
});

const runValidation = (schema, inputData) => {
  const validationResult = Joi.compile(schema)
    .prefs({ errors: { label: "key" }, abortEarly: false })
    .validate(inputData);

  if (validationResult.error) {
    // Validation failed
    console.log("Error, validation failed");
    // Set error message to string
    const errorMessage = validationResult.error.details
      .map((details) => details.message)
      .join(", ");
    console.log("failure reason - ", errorMessage);
    return;
  }
  console.log("validation passed");
};
runValidation(schema, inputData);

<script src="https://cdn.jsdelivr.net/npm/<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="452f2a2c0574726b736b75">[email protected]</a>/dist/joi-browser.min.js"></script>

Answer 5

Answer №3

It is crucial to establish validation rules for any tool you utilize, even if it's a preexisting one. Given that expertise in these tools may vary, writing custom code in your preferred language could simplify the process. For instance, a JavaScript snippet can effectively handle this task:

function validateJson(jsonToValidate, maxValue = 56) {
  if (jsonToValidate.optionsMaxValue !== maxValue) {
    console.log("Failure on optionsMaxValue.");
    return false;
  }
  if (jsonToValidate.options.length !== maxValue+1) {
    console.log("Incorrect number of items.");
    return false;
  }
  let values = jsonToValidate.options.map(a => a.value).sort();
  if (values[0] !== 0 || values[maxValue] !== maxValue) {
    console.log("Values out of desired sequence.");
    return false;
  }
  let sum = values.reduce((a, b) => a + b, 0);
  if (sum !== maxValue * (maxValue + 1) / 2) {
    console.log("Values out of desired sequence.");
    return false;
  }
  console.log("Validation PASSED.");
  return true;
}

Let's consider an example with a truncated JSON object:

let jsonSample = {
  "optionsMinValue": 0,
  "optionsMaxValue": 2,
  "options": [{
      "name": "name1",
      "value": 0
    },
    {
      "name": "name2",
      "value": 1
    },
    {
      "name": "name3",
      "value": 2
    }
  ]
};

function validateJson(jsonToValidate, maxValue = 56) {
  if (jsonToValidate.optionsMaxValue !== maxValue) {
    console.log("Failure on optionsMaxValue.");
    return false;
  }
  if (jsonToValidate.options.length !== maxValue+1) {
    console.log("Incorrect number of items.");
    return false;
  }
  let values = jsonToValidate.options.map(a => a.value).sort();
  if (values[0] !== 0 || values[maxValue] !== maxValue) {
    console.log("Values out of desired sequence.");
    return false;
  }
  let sum = values.reduce((a, b) => a + b, 0);
  if (sum !== maxValue * (maxValue + 1) / 2) {
    console.log("Values out of desired sequence.");
    return false;
  }
  console.log("Validation PASSED.");
  return true;
}

validateJson(jsonSample, 2);

Answer 6

It is crucial to establish validation rules for any tool you utilize, even if it's a preexisting one. Given that expertise in these tools may vary, writing custom code in your preferred language could simplify the process. For instance, a JavaScript snippet can effectively handle this task:

function validateJson(jsonToValidate, maxValue = 56) {
  if (jsonToValidate.optionsMaxValue !== maxValue) {
    console.log("Failure on optionsMaxValue.");
    return false;
  }
  if (jsonToValidate.options.length !== maxValue+1) {
    console.log("Incorrect number of items.");
    return false;
  }
  let values = jsonToValidate.options.map(a => a.value).sort();
  if (values[0] !== 0 || values[maxValue] !== maxValue) {
    console.log("Values out of desired sequence.");
    return false;
  }
  let sum = values.reduce((a, b) => a + b, 0);
  if (sum !== maxValue * (maxValue + 1) / 2) {
    console.log("Values out of desired sequence.");
    return false;
  }
  console.log("Validation PASSED.");
  return true;
}

Let's consider an example with a truncated JSON object:

let jsonSample = {
  "optionsMinValue": 0,
  "optionsMaxValue": 2,
  "options": [{
      "name": "name1",
      "value": 0
    },
    {
      "name": "name2",
      "value": 1
    },
    {
      "name": "name3",
      "value": 2
    }
  ]
};

function validateJson(jsonToValidate, maxValue = 56) {
  if (jsonToValidate.optionsMaxValue !== maxValue) {
    console.log("Failure on optionsMaxValue.");
    return false;
  }
  if (jsonToValidate.options.length !== maxValue+1) {
    console.log("Incorrect number of items.");
    return false;
  }
  let values = jsonToValidate.options.map(a => a.value).sort();
  if (values[0] !== 0 || values[maxValue] !== maxValue) {
    console.log("Values out of desired sequence.");
    return false;
  }
  let sum = values.reduce((a, b) => a + b, 0);
  if (sum !== maxValue * (maxValue + 1) / 2) {
    console.log("Values out of desired sequence.");
    return false;
  }
  console.log("Validation PASSED.");
  return true;
}

validateJson(jsonSample, 2);

Validation of JSON array items

Answer №1

Answer №2

Answer №3

Similar questions

Retrieve the value from a checkbox using Flask and then transfer the extracted data to a different template

"Retrieving Data Using jQuery's .ajax Method in Visual Basic

The benefits of using a list in JSON

Tips for showing the parsed JSON data in a TableView using a TextField

Error: NativeScript has encountered difficulty locating the module "@nativescript/schematics"

Using @GET parameters with Android's retrofit

Extract JSON elements from a massive document

Differences between JSON.stringify and serialization methods

Converting JSON formats with Python module: A step-by-step guide

Executing a CRM javascript button triggers a request to a JSON URL and extracts a specific value

Utilizing CakePHP 3.0 with jQuery UI for an autocomplete feature

Mapping an array of strings to model field values in EXTJS

Tips for building a versatile fetch function that can be reused for various JSON formats within a React application

List view encountered a null object reference

Imagine a scenario where your json_encode function returns API data that is already in JSON format. What would

guide for interpreting a complex json structure

Is there a solution to address the error message: json.decoder.JSONDecodeError: Expecting value at line 1, column 1 (character 0)?

Unable to convert the text string into my desired object

Error encountered while making an http get request for a node that returns JSON

Using Angular to Apply a Custom Validation Condition on a FormGroup Nested Within Another FormGroup