roskenet / json-fields

A Framework for limiting fields of JSON objects exposed by Rest APIs

JSON fields

This is a proposed standard extension to Rest APIs that return JSON.

If and when the request contains a query parameter named "fields" with a blacklist or whitelist of the form

(field1!(subfield1, subfield2),field2(subfield3, subfield4)

Then the returned JSON would contain only the fields "field1" and "field2", which in turn would contain the nested properties "field2.subfield3", "field2.subfield4", and all fields from "field1" except "subfield1" and "subfield2".

The "grammar" sub-project contains the underlying ANTLR4 grammar, other projects may provide implementations of the grammar for different languages and environments.

You can find the grammar at grammar/src/main/antlr4/JsonFields.g4

Also check out this Unit Test Class for valid field expressions according to this grammar: JsonFieldsGrammarSyntaxTest.java