Accueil › Spring Boot › Lire la requête : @PathVariable, @RequestParam, @RequestBody
Lire la requête : @PathVariable, @RequestParam, @RequestBody
Créer une API RESTdebutant
Trois annotations couvrent l'essentiel de la lecture d'une requête HTTP :
@RestController
@RequestMapping("/produits")
public class ProduitController {
// /produits/42 → id vient du chemin
@GetMapping("/{id}")
public Produit get(@PathVariable Long id) { ... }
// /produits?categorie=informatique&page=0 → paramètres de requête
@GetMapping
public List<Produit> lister(
@RequestParam(required = false) String categorie,
@RequestParam(defaultValue = "0") int page) { ... }
// Corps JSON désérialisé en objet
@PostMapping
public Produit creer(@RequestBody ProduitDto dto) { ... }
}
public record ProduitDto(String nom, double prix) { }
@PathVariable lit une portion de l'URL (identifie une ressource précise). @RequestParam lit un paramètre de la chaîne de requête après le ? (filtrage, pagination, tri). @RequestBody désérialise le corps de la requête (JSON → objet Java) avec Jackson. @RequestHeader lit un en-tête HTTP.
Spring convertit automatiquement les types simples (Long, int, boolean…). En cas d'échec — paramètre requis absent, type invalide, JSON illisible — la réponse est un 400 Bad Request géré par défaut par Spring Boot.
Les termes à connaître
- @PathVariable
Récupère une portion de l'URL déclarée entre accolades dans le mapping, par exemple
{id}dans/produits/{id}. Utilisé pour identifier une ressource précise.- @RequestParam
Récupère un paramètre de la chaîne de requête (
?page=2&taille=20) ou d'un formulaire. Sert au filtrage, à la pagination, au tri : ce qui n'identifie pas une ressource unique.- @RequestBody
Désérialise le corps de la requête (généralement du JSON) vers un objet Java ou un record. Utilisé avec
POST,PUT,PATCH.- @RequestHeader
Récupère un en-tête HTTP de la requête, par exemple
@RequestHeader("Authorization") String token.- required et defaultValue
Attributs de
@RequestParam(et@RequestHeader) :required = falserend le paramètre optionnel (il devientnull, ou vaut le type par défaut),defaultValue = "..."fournit une valeur si le paramètre est absent (impliquerequired = false).- DTO
Data Transfer Object : un objet dédié au transport des données entre le client et l'API, distinct de l'entité JPA. Un record convient bien : immuable, concis, avec
equals/hashCode/toStringgénérés.- HttpMessageNotReadableException
Erreur levée quand Spring ne parvient pas à désérialiser le corps de la requête en objet Java (JSON absent, malformé, ou type incompatible). Traduite en réponse 400 Bad Request.
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.