Discussion :

[DeathMaker]

Bonjour,

Une petite interrogation sur la mise en place d'une architecture REST.
Partons d'un exemple: Une ressource COMMANDE qui peut être annulée.
Voici une représentation possible:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
<order id="">
	<canceled>false</canceled>
</order>

Pour annuler cette commande, on pourrait faire un PUT sur la ressource en modifiant l'élément "<canceled>" pour le passer à "true".

Or, le client DOIT avoir connaissance cette astuce pour pouvoir annuler la commande.
Ce qui n'est pas recommandé dans une archi REST qui veut que le client puisse s'orienter seul dans ses actions possible: Le fameux HATEOS.

Alors on trouve quelques exemples qui préconisent ce genre de fonctionnement:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
<order id="">
	<link rel="cancel" href="/order/18/cancel" />
</order>

Un lien permettant d'annuler la commande est donc retourné au client.
Génial.


Sauf que cette URI "/commande/18/cancel" amène quelques remarques:
* Quelle ressource concerne-t-elle ?
* "cancel", c'est une action ça ?! On retourne vers un design RPC...

Alors comment résoudre ce problème ?
* Créer une ressource /canceledOrder et faire un POST dessus pour créer une commande annulée ?
Du coup la représentation pourrait être:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
<order id="">
	<link rel="cancel" href="/canceledOrder" method="POST" />
</order>

Et celle-ci, quand la commande est effectivement annulée:

Code :

Sélectionner tout - Visualiser dans une fenêtre à part

1
2
3
4
5
6
<order id="">
	<canceled>
		<value>true</value>
		<link href="/canceledOrder/18"/>
	</canceled>
</order>

Qu'en pensez-vous ? Comment avez-vous résolu ce genre de problèmatique ?

Merci !

[wiztricks]

Salut,

Pour annuler cette commande, on pourrait faire un PUT sur la ressource en modifiant l'élément "<canceled>" pour le passer à "true".

Or, le client DOIT avoir connaissance cette astuce pour pouvoir annuler la commande.

Si vous indiquez l'URI sur laquelle appliquer le POST qui... ce n'est plus "une astuce" mais la documentation de l'API (rest) proposée.

Sauf que cette URI "/commande/18/cancel" amène quelques remarques:
* Quelle ressource concerne-t-elle ?
* "cancel", c'est une action ça ?! On retourne vers un design RPC...

L'intérêt de cette "forme" (par rapport à la précédente) est que l'URI retournée est "opaque". Seul le serveur devra savoir quoi faire lorsqu'il recevra un POST sur cette "ressource". De plus, on pourra changer son format sans avoir à modifier l'API (côté client)

Dans les deux cas, il est possible d'annuler commande X... Fonctionnellement c'est équivalent. Ce qui change c'est la documentation de l'API (et sa réalisation) avec plus ou moins de latitude pour "changer" quelques éléments de réalisation.

- W

[DeathMaker]

Merci pour votre réponse.

Si je comprends bien votre réponse, tant qu'un lien (rel="cancel") est présent, peut importe sur quel URI il pointe (href) ?

Ce qui me dérange, c'est cette URI justement: "order/12/cancel". Elle doit permettre d'identifier une ressource. Alors que dans ce cas, elle sert uniquement à effectuer une action sur une ressource.

[wiztricks]

Salut,

Ce qui me dérange, c'est cette URI justement: "order/12/cancel"
Elle doit permettre d'identifier une ressource. Alors que dans ce cas, elle sert uniquement à effectuer une action sur une ressource.

Vous essayez de généraliser les attributs d'une couche "basse". Ca va bien pour représenter des ressources read only voire des actions type CRUD.

Lorsque dans un document on trouve des <link rel=...>, nous sommes - pour faire simple - dans le domaine des "documents hypermedia".
Nous ne sommes plus dans la représentation d'une ressource simple mais dans une application qui organise des transitions d'état de ressources ayant des liens entre elles.

Les "<link rel=...>" ont été introduit par Atom le protocole de publication, et sont généralisés par HTML5. REST dans ce cadre reste la "brique de base" de la construction mais le changement d'échelle le relègue au niveau de "détail".

Je ne suis pas certain d'être assez clair.
Désolé
- W