How to remove null parameters in a json rest response?

Question

I'm creating a rest service with spring and want to offer a json response:

@RequestMapping(value = "/test",
        method = RequestMethod.GET,
        produces = MediaType.APPLICATION_JSON_VALUE)
@ResponseBody
public MyResponse content() {
    return rsp;
}

MyResponse may contain null values which should not be returned in the JSON response (these params should just be removed).

@XmlRootElement
class MyResponse {
}

Is that possible?

I don't know. I'm just using spring-boot and the @RestController annotation. — membersound
– membersound, Commented Jul 17, 2015 at 13:06

Christophe Schutz · Accepted Answer · 2015-07-17 13:10:39Z

18

Try this :

@JsonInclude(JsonInclude.Include.NON_NULL)
class MyResponse {
...
}

You'll need to update your dependencies and import this :

import com.fasterxml.jackson.annotation.JsonInclude;

answered Jul 17, 2015 at 13:10

Christophe Schutz

7135 silver badges21 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

robothy · Accepted Answer · 2020-05-07 02:41:09Z

7

Globally remove null property.

spring.jackson.default-property-inclusion = non_null

answered May 7, 2020 at 2:41

robothy

1,42014 silver badges20 bronze badges

3 Comments

Christophe Schutz Over a year ago

That's a very neat trick that is indeed elegant and handy given I almost always annotate all my DTOs with @JsonInclude(JsonInclude.Include.NON_NULL). Thanks !

Paul Davies Over a year ago

I am not sure why this was not marked as an answer. Simple and straight forward yet it works.

Atul Panda Over a year ago

This is really elegant. But I think it works with the latest spring-boot version 2.5.0

Collectives™ on Stack Overflow

How to remove null parameters in a json rest response?

2 Answers 2

Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related