Accueil › Spring Boot › @RestController et les mappings HTTP
@RestController et les mappings HTTP
Créer une API RESTdebutant
@RestController combine @Controller (la classe est un bean qui gère des requêtes web) et @ResponseBody (chaque méthode écrit son résultat directement dans le corps de la réponse, sérialisé en JSON par Jackson). C'est l'annotation de base pour exposer une API REST.
@RestController
@RequestMapping("/produits")
public class ProduitController {
@GetMapping
public List<Produit> lister() {
return List.of(new Produit(1L, "Clavier", 49.90));
}
@GetMapping("/{id}")
public Produit get(@PathVariable Long id) {
return new Produit(id, "Clavier", 49.90);
}
@PostMapping
public Produit creer(@RequestBody Produit produit) {
return produit; // en réalité, on l'enregistrerait
}
}
@RequestMapping("/produits") sur la classe donne le préfixe commun. Chaque méthode utilise ensuite le mapping du verbe HTTP qui correspond à son action : @GetMapping (lire), @PostMapping (créer), @PutMapping (remplacer), @PatchMapping (modifier partiellement), @DeleteMapping (supprimer).
Les conventions REST : une URL désigne une ressource, nommée au pluriel (/produits), jamais un verbe. C'est le verbe HTTP qui porte l'action, pas l'URL.
Les termes à connaître
- @RestController
Raccourci pour
@Controller+@ResponseBody. Chaque méthode renvoie directement des données (JSON, texte…) écrites dans le corps de la réponse HTTP, au lieu d'un nom de vue à afficher.- @RequestMapping
Annotation générique qui associe une classe ou une méthode à une URL. Posée sur la classe, elle donne le préfixe commun à toutes les méthodes du contrôleur, par exemple
@RequestMapping("/produits").- @GetMapping, @PostMapping, @PutMapping, @PatchMapping, @DeleteMapping
Variantes spécialisées de
@RequestMappingpour chaque verbe HTTP. Plus lisibles que@RequestMapping(method = RequestMethod.GET).- Sérialisation JSON
La conversion automatique d'un objet Java (ou d'un record) en JSON par Jackson, la librairie incluse dans
spring-boot-starter-web. Chaque propriété (getter, ou composant du record) devient un champ JSON.- Méthode sûre (safe)
Une méthode HTTP qui ne modifie pas l'état du serveur :
GET. On peut l'appeler sans conséquence, la mettre en cache, la précharger.- Méthode idempotente
Un appel répété plusieurs fois produit le même résultat qu'un seul appel.
GET,PUTetDELETEsont idempotents.POSTne l'est pas : le rappeler crée une nouvelle ressource à chaque fois.PATCHne l'est pas garanti.- Ressource REST
L'entité manipulée par l'API, désignée par une URL et un nom au pluriel (
/produits,/produits/{id}). Le verbe HTTP porte l'action, pas l'URL : on évite/getProduitou/creerProduit.
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.