Does JSON value type need to be strictly defined?

user_10577399 0
Viewed 222

I have come across an API that returns different types of value for "fieldValue" as follow:

{
    "id" : 123,
    "fieldType" : "text",
    "fieldValue" : "some test"
}

{
    "id" : 456,
    "fieldType" : "checkbox",
    "fieldValue" : 
    [
        {
            "checkboxId" : 1,
            "name" : "Homer"
        },
        {
            "checkboxId" : 2, 
            "name" : "Marge"
        }
    ]
}

{
    "id" : 789,
    "fieldType" : "Select",
    "fieldValue" : {
        "selectId" : 3,
        "value" : "Lisa"
    }
}

I am using GSON and it doesn't like that the fact that "fieldValue" can be either String or an object or an array. I have written custom deserializer to parse it. My question is that does JSON specification allow JSON object to have loosely defined value type meaning fieldValue type can be either String, Array of objects or an object?

gson rest api json java
2 Answers

The JSON specification only mentions the syntax of the JSON object, not the semantics. So the parser will not check if a given value should be of type A or B. It will read whatever values are available and will report errors if the syntax is broken. It is up to your application to verify the contents and react accordingly.

user_42897000

No it does not even it sometimes might be a good policy. JSON specification itself does not tell what are the objects presented in JSON. That is in the responsibility of the API specification.

The API you have seems to rely on the discriminator field fieldType that I guess you are using to make your custom deserializing.

That is also the strategy that RuntimeTypeAdapterFactory uses which might be good solution also in your case.

user_64133770
Related