38 - ResponseEntity
O ResponseEntity é uma classe do Spring que representa uma resposta HTTP completa. Isso significa que, com ele, você pode:
- Definir o corpo da resposta (por exemplo, um objeto, uma lista, uma mensagem).
- Especificar o status HTTP (como 200 OK, 201 Created, 404 Not Found).
- Adicionar cabeçalhos personalizados se necessário.
Ele é muito utilizado quando precisamos ter controle total sobre a resposta da nossa API.
Como Funciona o ResponseEntity?
O ResponseEntity é utilizado para retornar uma resposta HTTP completa, com o status desejado, um corpo de resposta (se necessário) e cabeçalhos personalizados. Ele é útil principalmente quando queremos ter total controle sobre o que a API responde ao cliente.
Principais Métodos do ResponseEntity
- status(HttpStatus status): Define o status HTTP da resposta.
- body(Object body): Define o corpo da resposta.
- header(String name, String value): Adiciona um cabeçalho personalizado à resposta.
- ok(): Retorna um ResponseEntity com status 200 OK.
- created(URI location): Retorna um ResponseEntity com status 201 CREATED.
- badRequest(): Retorna um ResponseEntity com status 400 BAD REQUEST.
- notFound(): Retorna um ResponseEntity com status 404 NOT FOUND.
Benefícios do Uso do ResponseEntity
Utilizando o ResponseEntity, você tem:
- Controle total sobre o status da resposta.
- Capacidade de incluir cabeçalhos personalizados, se necessário.
- Flexibilidade para definir respostas completas em APIs RESTful.
Isso garante que a API se comporte de maneira mais robusta e flexível, proporcionando ao cliente uma comunicação clara sobre o sucesso ou falha de suas requisições.
Clique aqui para se tornar membro do canal
Abaixo segue nossa aula no YouTube: