CODEWITHSUNDEEP
javascriptjsonschema
Alexander Tsepkov
Alexander Tsepkov

Reputation: 4186

Parsing input based on JSON schema

We're building a frontend project for a web app that communicates with a backend written by another team. Some of the developers work on both projects, and have better understanding of changes to the backend and response fields coming back.

Recently we had portions of frontend break as they made changes in parts of the app based on changes to the backend without updating the logic in all places. To mitigate this I want to put in place a concept of a mask/template that all response data would be curated through. That way the rest of the members on the team who're not as familiar with the backend can notice/address these bugs.

To do so, I'm considering using JSON Schema. Instead of simply validating, however, I want to parse the backend data through it (removing the fields not present in the schema). This way the developer making changes in the frontend in response to a backend change would also need to update this template, therefore triggering a test failure until all logic using this schema is updated (not just the logic he touched). I'm playing with https://www.npmjs.com/package/jsonschema, but it doesn't seem to have a way to remove excess fields, just test for them.

Within JSON Schema, I can also set additionalProperties flag. However, it has 2 problems with it:

Perhaps validator is not the right tool for this, but that's all I'm finding when searching for JSON schema parsers. Can someone guide me in the right direction so that I don't reinvent the wheel? It sounds like this functionality is very similar to what a validator already does and I would rather do this processing in the same pass.

Upvotes: 3

Views: 3661

Answers (1)

Alexander Tsepkov
Alexander Tsepkov

Reputation: 4186

Found a validator that does what I want: https://github.com/acornejo/jjv. It has removalAdditional flag that I can set, here is a quick test I did:

var jjv = require('jjv')();

var addressSchema = {
    "id": "address",
    "type": "object",
    "properties": {
        "lines": {
            "type": "array",
            "items": {"type": "string"}
        },
        "zip": {"type": "string"},
        "city": {"type": "string"},
        "country": {"type": "string"}
    },
    "required": ["country"]
};

var schema = {
    "id": "person",
    "type": "object",
    "properties": {
        "name": {"type": "string"},
        "address": {"$ref": "address"},
        "votes": {"type": "integer", "minimum": 1}
    }
};

var p = {
    "name": "Barack Obama",
    "address": {
        "lines": [ "1600 Pennsylvania Avenue Northwest" ],
        "zip": "DC 20500",
        "city": "Washington",
        "foobar": "baz",
        "country": "USA"
    },
    "a": {
      "b": 1,
      "c": 2
    },
    "votes": "lots",
    "stuff": "yes"
};

jjv.addSchema('address', addressSchema);
jjv.addSchema('schema', schema);
jjv.defaultOptions.checkRequired = true;
jjv.defaultOptions.removeAdditional = true;
console.log(jjv.validate('schema', p));
console.log(p);

And a response:

    { validation: { votes: { type: 'integer' } } }
    { name: 'Barack Obama',
        address:
         { lines: [ '1600 Pennsylvania Avenue Northwest' ],
             zip: 'DC 20500',
             city: 'Washington',
             country: 'USA' },
        votes: 'lots' }

Upvotes: 2

Related Questions