TP 4 : initiation aux services Web (programmation REST)

Objectifs pédagogiques du TP

• Comprendre les grands principes de l'approche REST
• Se familiariser avec la programmation orientée-ressource
• Utiliser les annotations REST de Spring

Références

• Cours : voir le cours REST de Pierre-Antoine Champin
• Une explication de la sémantique des verbes HTTP et la différence entre la programmation orientée-objet et orientée-ressource
• Un résumé des principales caractéristiques de REST à implémenter vu par Spring
• Deux tutoriels Spring : Getting started et Tuto complet (rappel : vous n'avez pas droit à Spring Boot)
• La Documentation officielle de Spring Web MVC

Préambule

Dans ce TP, vous repartirez de l'application de back-office du chat en Spring Web MVC réalisée dans le TP précédent. Vous l'améliorerez pour faire en sorte que les objets métier de cette application soient gérés sous forme de ressources.

Remarque : l'authentification en REST étant un problème complexe, vous conserverez la méthode utilisée dans le TP précédent (cookies + Filter).

Ressources

Logiquement, au TP précédent, vous avez transformé tous les objets manipulés côté serveur en ressources. Le travail qui doit déjà être fait est que les ressources exposées par votre application (utilisateurs, salons, messages), ont chacune une URI qui lui est propre et que le serveur renvoie une représentation de cette ressource à une requête vers cette URI. Pour cela, vous devez avoir :

• un contrôleur Spring qui récupère les requêtes pour chaque type de ressource
• des composants (beans) capables de gérer le métier de ces ressources et dont le cycle de vie (création / destruction) est géré par le contrôleur
• des méthodes (Java) du contrôleur qui réalisent le mapping entre les méthodes (HTTP) des requêtes et l'appel (getters / setters) des beans
• un ViewResolver qui renvoie une représentation (vue) de la ressource demandée en fonction de la valeur de retour du contrôleur

Métier de l'application

À l'aide de la documentation indiquée dans la partie Références, étendez votre application pour qu'elle expose, en accord avec la sémantique des verbes HTTP, les ressources et les fonctionnalités suivantes :

• Utilisateur
  • Récupérer le pseudo et la liste des salons auxquels il a participé
  • Modifier le pseudo
• salon
  • Récupérer la liste des messages
  • Récupérer le nombre de messages
  • Récupérer tous les messages envoyés après un message donné, dont l'id sera passé en paramètre
  • Ajouter un message
  • Supprimer un salon
• Message
  • Récupérer les informations du message (auteur, texte)
  • Modifier le contenu du dernier message d'un salon (doit renvoyer une erreur si ce n'est pas le dernier message)
  • Supprimer le dernier message d'un salon (doit renvoyer une erreur si ce n'est pas le dernier message)

Remarque : vous pouvez créer d'autres sous-ressources qui vous paraissent appropriées pour réaliser ces traitements.

Négociation de contenus

Utilisez la doc située ici pour faire en sorte qu'en fonction des headers HTTP de la requête, votre serveur renvoie une représentation des ressources différente :

• JSON si le client a indiqué qu'il l'acceptait
• XML si le client a indiqué qu'il l'acceptait
• Sinon, HTML

Gestion des codes de statut et d'erreur

En utilisant un HandlerExceptionResolver, gérez différentes exceptions comme indiqué dans la documentation. Commentez votre code pour indiquer comment les obtenir lors de la correction.

Hypermédia (bonus)

Faites en sorte que les représentations de chaque ressource contiennent un maximum de liens explicites vers les ressources apparentées ; par exemple, la représentation du salon devrait contenir un lien (permalink) vers chaque message.

Par ailleurs lorsqu'une ressource a été créée, un lien doit être renvoyé dans (header HTTP location de la réponse), contenant l'URI de cette nouvelle ressource.

Instructions de rendu

Vous pousserez une nouvelle version de votre projet sur la forge, avec les modifications demandées par le passage à REST de votre application Spring. Le dernier commit doit dater au plus tard du dimanche 2 décembre 2018 au soir.