jsonspringrest

Spring Boot: Return a empty JSON instead of empty body when returned object is null


I have a RestController and when I call the method:

@RequestMapping(value = "/sigla/{sigla}")
@ResponseBody
public PaisDTO obterPorSigla(@PathVariable String sigla) {
    return service.obterPorSigla(sigla);
}

If a record is found, I get a good JSON response:

{"nome":"Brasil","sigla":"BR","quantidadeEstados":27}

but when nothing is found on database the RestController returns null and I get a empty response, completely blank body.

How can I display a empty JSON instead of a blank response? Like bellow:

{}

Complete Controller:

@RestController
@RequestMapping("/pais")
public class PaisController {

    @Autowired
    private PaisService service;

    @RequestMapping
    public ResponseEntity<List<PaisDTO>> obterTodos() {
        return CreateResponseEntity.getResponseEntity(service.obterTodos());
    }

    @RequestMapping(value = "/sigla/{sigla}", method = RequestMethod.GET, consumes="application/json", produces="application/json")
    public ResponseEntity<PaisDTO> obterPorSigla(@PathVariable String sigla) {
        HttpHeaders headers = new HttpHeaders();
        headers.add("Content-Type", "application/json");
        PaisDTO paisDTO = service.obterPorSigla(sigla);
        if(paisDTO != null) return new ResponseEntity<PaisDTO>(paisDTO, headers, HttpStatus.OK);
        else return new ResponseEntity<PaisDTO>(headers, HttpStatus.OK);
    }

Solution

  • First, if you're using @RestController annotation you don't need the @ResponseBody annotation, get rid of that.

    Second if you're trying to have REST Controller, then you're missing a few things, do it like this:

    @RequestMapping(value = "/sigla/{sigla}", method = RequestMethod.GET, consumes = "application/json", produces="application/json")
    public ResponseEntity<PaisDTO> obterPorSigla(@PathVariable String sigla) {
            HttpHeaders headers = new HttpHeaders();
            headers.add("Content-Type", "application/json");    
            PaisDTO paisDTO = service.obterPorSigla(sigla);
            if(paisDTO != null) return new ResponseEntity<>(paisDTO, headers, HttpStatus.OK);
            else return new ResponseEntity<>(headers, HttpStatus.OK); 
    }
    

    In the example above if you'll get null then you'll return an empty response JSON.