JSON response for REST API

Question

I have made a REST API in java and I have the following DTO.

@ApiModel(value = "testType", description = "Test type")
public class TestType
{
    private int type;
    private String typeName;
    private boolean isTypeSpecial;
    private boolean isTypeTrue;

    @JsonInclude(JsonInclude.Include.NON_ABSENT)
    private List<typeMasterDTO> typeMasterList;

    public TestType()
    {
    }

    @ApiModelProperty(example = "0", value = "Type", required = true)
    public int getType()
    {
        return type;
    }

    public void setType(int type)
    {
        this.type= type;
    }

    @ApiModelProperty(example = "Dragon", value = "Name of the typw",             required = true)
    public String getTypeName()
    {
        return typeName;
    }

    public void setTypeName(String typeName)
    {
        this.typeName= typeName;
    }

    @ApiModelProperty(value = "It is a special type", required = true)
    public boolean isTypeSpecial()
    {
        return isTypeSpecial;
    }

    public void setTypeSpecial(boolean isTypeSpecial)
    {
        this.isTypeSpecial= isTypeSpecial;
    }

    @ApiModelProperty(value = "It is a true type", required = true)
    public boolean isTypeTrue()
    {
        return isTypeTrue;
    }

    public void setTrueType(boolean isTypeTrue)
    {
        this.isTypeTrue= isTypeTrue;
    }

    @ApiModelProperty(value = "List of types")
    public List<typeMasterDTO> getTypeMasterList()
    {
        return typeMasterList;
    }

    public void setTypeMasterList(List<typeMasterDTO> typeMasterList)
    {
        this.typeMasterList= typeMasterList;
    }

}

In my API class, I get the data for the above DTO from sql and return the response using the code:

Response com.mmp.rest.AbstractResource.buildResponse(Response<?> response, ResponseMode mode)

The output I get looks like this:

[
      {
            "type": 1,
            "typeName": "New type",
            "typeMasterList": [
                {
                    "typeMaster": 0,
                    "typeMasterName": "Default"
                },
                {
                    "typeMaster": 1,
                    "typemasterName": "Custom"
                }
            ],
            "TypeTrue": false,
            "TypeSpecial": true
    }
]

So my doubts are:

Why does the Object list come in third in the response even though I have declared it last in the DTO?
Why is isTypeTrue and isTypeSpecial shown as TypeTrue and TypeSpecial in the output?
Why has isTypeTrue appeared first and isTypeSpecial appeared afterwards even though I declared isTypeSpecial first?
Is there any way i can learn how the buildResponse works?

luk2302 · Answer 1 · 2018-09-17T08:42:45.600

1

Because the order is irrelevant. On JSON level it basically is a unordered key-value map. The order must not matter to you or the one who parses. Only stuff inside [ ... ] will keep its order since that is an ordered list / array.
boolean fields are a bit special in their getter naming, see e.g. For a boolean field, what is the naming convention for its getter/setter? - the is... is like the get... for regular getters and is therefore stripped away.
same as 1.
yes, e.g. set a breakpoint and step into the method using your IDE + debugger - but it will probably not be fun to look at the code

edited Sep 17 '18 at 08:42

answered Sep 17 '18 at 08:36

luk2302

55,258
23
97
137

Wow, that was precise and informative..thank you However, I tried debugging into Response Builder and I enter the "source not found...Jar file has no source attachment" page. – Rohan Joseph George Sep 17 '18 at 10:41
@RohanJosephGeorge what IDE are you using? – luk2302 Sep 17 '18 at 10:44
I am using eclipse – Rohan Joseph George Sep 17 '18 at 10:47

score 0 · Answer 2 · answered Sep 17 '18 at 08:43

This is because the JSONObject implementation uses HashMap by default. HashMap will order it alphabetically. Mostly a JSON response order is irrelevant, if the answer contains the value you need, it is all good.
The JSON framework renames your primitive variables by removing the 'is' and 'has' word from your variable name. You can add a different name by adding @JsonProperty(value="isTypeSpecial")
This answer is stated in answer 1, it is because of the alphabetical order in a HashMap
It is possible with debugging, but I think you don't want to go in debt to much

Hopefully this answers your questions.

Yes, that did answer my questions. @JsonProperty is a neat way to bypass it, thank you. — Rohan Joseph George, Sep 17 '18 at 10:43

JSON response for REST API

2 Answers2