Accueil › Spring Boot › Construire la réponse : ResponseEntity et codes HTTP
Construire la réponse : ResponseEntity et codes HTTP
Créer une API RESTdebutant
Un contrôleur qui retourne directement un objet répond toujours 200 OK. ResponseEntity<T> permet de choisir précisément le code HTTP, les en-têtes et le corps de la réponse.
@RestController
@RequestMapping("/produits")
public class ProduitController {
@GetMapping("/{id}")
public ResponseEntity<Produit> get(@PathVariable Long id) {
return service.trouver(id)
.map(ResponseEntity::ok) // 200
.orElse(ResponseEntity.notFound().build()); // 404
}
@PostMapping
public ResponseEntity<Produit> creer(@RequestBody CreationProduitDto dto) {
Produit produit = service.creer(dto);
URI location = ServletUriComponentsBuilder.fromCurrentRequest()
.path("/{id}")
.buildAndExpand(produit.id())
.toUri();
return ResponseEntity.created(location).body(produit); // 201 + Location
}
@DeleteMapping("/{id}")
public ResponseEntity<Void> supprimer(@PathVariable Long id) {
service.supprimer(id);
return ResponseEntity.noContent().build(); // 204
}
}
ResponseEntity.ok(corps) pour un succès, .created(uri).body(corps) pour une création (avec l'en-tête Location), .noContent().build() pour un succès sans contenu, .notFound().build() quand la ressource n'existe pas.
Les termes à connaître
- ResponseEntity
Classe qui représente une réponse HTTP complète : code de statut, en-têtes et corps. Permet de contrôler précisément ce que l'API renvoie, contrairement à un retour d'objet simple (toujours 200).
- ResponseEntity.ok(...)
Construit une réponse 200 OK avec le corps donné.
ResponseEntity.ok().build()pour un 200 sans corps.- ResponseEntity.created(URI)
Construit une réponse 201 Created avec l'en-tête
Locationpointant vers la ressource créée. Le corps s'ajoute ensuite avec.body(...).- ServletUriComponentsBuilder
Utilitaire Spring MVC pour construire l'URI de la ressource créée à partir de la requête courante, par exemple
ServletUriComponentsBuilder.fromCurrentRequest().path("/{id}").buildAndExpand(id).toUri().- @ResponseStatus
Annotation qui fixe le code HTTP renvoyé par une méthode de contrôleur, ou associé à une exception. Alternative simple à
ResponseEntityquand le code est toujours le même.- ResponseEntity.notFound() / noContent()
notFound().build()construit une réponse 404 sans corps.noContent().build()construit une réponse 204 sans corps, typiquement après une suppression réussie.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.