При использовании ResponseEntity и @RestController для приложений Spring RESTful

чтобы завершить ответ от Sotorios Delimanolis.

Это правда ResponseEntity дает вам больше гибкости, но в большинстве случаев вам это не понадобится, и вы получите эти ResponseEntity везде в вашем контроллере, что делает его трудно читать и понимать.

если вы хотите обрабатывать особые случаи, такие как ошибки (не найдено, конфликт и т. д.), вы можете добавить HandlerExceptionResolver к вашей конфигурации весны. Поэтому в вашем коде вы просто бросаете определенное исключение (NotFoundException например) и решить, что делать в вашем обработчике (установка статуса HTTP 404), что делает код контроллера более ясным.

согласно официальной документации:создание контроллеров REST с аннотацией @RestController

@RestController-это стереотипная аннотация, которая объединяет @ResponseBody и @контроллер. более того, это дает больше смысла вашей Контроллер, а также может нести дополнительную семантику в будущих выпусках из рамок.

кажется, что лучше использовать @RestController для ясности, но вы также можете комбината С ResponseEntity для гибкости при необходимости (согласно официальному учебнику и здесь код и мой вопрос, чтобы подтвердить, что).

например:

@RestController
public class MyController {

    @GetMapping(path = "/test")
    @ResponseStatus(HttpStatus.OK)
    public User test() {
        User user = new User();
        user.setName("Name 1");

        return user;
    }

}

- это то же, что:

@RestController
public class MyController {

    @GetMapping(path = "/test")
    public ResponseEntity<User> test() {
        User user = new User();
        user.setName("Name 1");

        HttpHeaders responseHeaders = new HttpHeaders();
        // ...
        return new ResponseEntity<>(user, responseHeaders, HttpStatus.OK);
    }

}

таким образом, вы можете определить ResponseEntity только при необходимости.

обновление

вы можете использовать это:

    return ResponseEntity.ok().headers(responseHeaders).body(user);

правильный REST API должен иметь ниже компонентов в ответ

1. Код Состояния
2. Ответ Тела
3. расположение к ресурсу, который был изменен(например, если ресурс был создан, клиенту было бы интересно узнать url этого местоположения)

основной целью ResponseEntity было предоставить Вариант 3, остальные варианты могут быть достигнуты без ResponseEntity.

Так что если вы хотите указать местоположение ресурсов, то с помощью ResponseEntity было бы лучше, иначе его можно избежать.

Рассмотрим пример, где API изменяется, чтобы предоставить все упомянутые параметры

// Step 1 - Without any options provided
@RequestMapping(value="/{id}", method=RequestMethod.GET)
public @ResponseBody Spittle spittleById(@PathVariable long id) {
  return spittleRepository.findOne(id);
}

// Step 2- We need to handle exception scenarios, as step 1 only caters happy path.
@ExceptionHandler(SpittleNotFoundException.class)
@ResponseStatus(HttpStatus.NOT_FOUND)
public Error spittleNotFound(SpittleNotFoundException e) {
  long spittleId = e.getSpittleId();
  return new Error(4, "Spittle [" + spittleId + "] not found");
}

// Step 3 - Now we will alter the service method, **if you want to provide location**
@RequestMapping(
    method=RequestMethod.POST
    consumes="application/json")
public ResponseEntity<Spittle> saveSpittle(
    @RequestBody Spittle spittle,
    UriComponentsBuilder ucb) {

  Spittle spittle = spittleRepository.save(spittle);
  HttpHeaders headers = new HttpHeaders();
  URI locationUri =
  ucb.path("/spittles/")
      .path(String.valueOf(spittle.getId()))
      .build()
      .toUri();
  headers.setLocation(locationUri);
  ResponseEntity<Spittle> responseEntity =
      new ResponseEntity<Spittle>(
          spittle, headers, HttpStatus.CREATED)
  return responseEntity;
}

// Step4 - If you are not interested to provide the url location, you can omit ResponseEntity and go with
@RequestMapping(
    method=RequestMethod.POST
    consumes="application/json")
@ResponseStatus(HttpStatus.CREATED)
public Spittle saveSpittle(@RequestBody Spittle spittle) {
  return spittleRepository.save(spittle);
}

источник - Весна в действии