Mettre à jour une propriété unique dans une API REST

Dans la conception d'une nouvelle API, nous faisons de notre mieux pour suivre les schémas établis par le REPOS. La question que je me pose est la meilleure méthode à suivre lorsque vous essayez de mettre à jour une propriété unique. Par exemple:

Imaginez que vous avez une simple Voiture de ressources:

{
   "make": "Chevrolet",
   "model": "Chevelle",
   "year": 1966,
   "color": "black",
   "for_sale": true
}

Supposons que la propriété for_sale est quelque chose que vous pensez sera mis à jour régulièrement par l'utilisateur. J'ai deux options:

PUT la totalité de la ressource avec for_sale ensemble de false. Pour une taille raisonnable des ressources, cela semble bien, cependant, dans la plupart des cas, nos ressources sont assez grandes, d'un lot de déchets dans l'envoi de la totalité de la ressource pour mettre à jour un seul, souvent changé de propriété.
POST et de faire une mise à jour partielle en n'incluant l'élément à mettre à jour, tels que:
{"for_sale":false} C'est mieux car il nécessite beaucoup moins de frais généraux.

Mais j'ai en quelque sorte semblent être atteint pour quelque chose d'encore plus simple, mais je ne semble pas trouver la bonne approche. Il serait très pratique de proposer un simple PUT à une URL (qui ne nécessite pas de corps de la requête) pour mettre à jour cette propriété. Je vois ce que Google est en train de faire dans leur API pour accomplir cela, mais il se sent juste un peu RPC-ish, bien que j'aime la simplicité.

POST /blogs/blogId/posts/postId/comments/commentId/approve
(marques d'un commentaire comme non spam)

POST /blogs/blogId/posts/postId/comments/commentId/spam (marques un commentaire comme spam)

Quelqu'un peut-il offrir quelques conseils sur la meilleure façon d'aborder la mise à jour d'une propriété unique dans un cadre de ressources (de préférence dans un léger manière) qui a suivi, RESTE principes? Merci!!!!

InformationsquelleAutor ski_junkie | 2014-02-20

api rest

11

Effectivement, je pense que le PATCH méthode est conçue spécifiquement pour cet usage. Vous devriez l'utiliser pour fournir une mise à jour partielle de l'objet, plutôt que d'une mise à jour complète. Voici une entrée de blog qui explique cela plus en détail.
- J'ai couvert le METTRE vs PATCH débat, ainsi que la "mise à jour partielle" rubrique dans ce blog: williamdurand.fr/2014/02/14/please-do-not-patch-like-an-idiot. Fondamentalement, il n'est pas une bonne fonctionnalité, cependant, c'est toujours ok pour faire partiellement mise à jour, et le PATCH méthode est la solution la plus appropriée.
- comme vous le dites dans votre blog, vous pouvez utiliser n'importe quel format que vous voulez pour le patch corps, bien que clairement rfc6902 est agréable, en supposant que tous les patchs sont de simples mises à jour, et en passant une propriété = valeur de la liste suffirait à résoudre le problème spécifique mentionné ici, où il n'y a pas besoin d'un diff complet du protocole.
- Vous devez définir la méthode de "mise à jour" propriétés", si vous avez besoin d'un format qui définit, d'où la nécessité pour RFC6902 ou similaires, non seulement quel que soit le format. Ce format doit définir la façon d'effectuer les modifications.
- Non, la sémantique peut être implicite. Il n'est pas "doit". Où l'application peut "seulement" remplacer la valeur nommée à celle donnée il n'est pas nécessaire pour un diff complet du protocole, et en effet ce serait du gaspillage d'en avoir un. Le monde de l'informatique a obtenu le long très bien pour les décennies sans un tel protocole, afin de "doit" est un très bon mot à utiliser. Bien sûr, je ne dis pas que l'OP n'a pas besoin d'une meilleure protocole, c'est juste que cette question ne demande pas un.
- PATCH avec tools.ietf.org/html/draft-ietf-appsawg-json-merge-patch-02 est très bien. @WilliamDURAND est exagérer les choses.
InformationsquelleAutor Engineer Dollery
0

Comme vous l'avez mentionné, qui est :

PUT la totalité de la ressource avec for_sale définie sur false. Pour une taille raisonnable des ressources, cela semble bien, cependant, dans la plupart des cas, nos ressources sont assez grandes, d'un lot de déchets dans l'envoi de la totalité de la ressource pour mettre à jour un seul, souvent changé de propriété.

Qui est vrai, donc pour ce genre de scénarios, je suggère la démarche suivante :

L'URI doit être quelque chose comme ceci :

POST /api/cars/C1234

Request Body: {"for_sale":false}
Que pas tous les serveurs web (et oublier les clients) soutien PATCH alors, les gens ont été supportant à la fois les mises à jour partielles avec POST:

Ce n'est pas parfait API RESTful design, mais j'ai vu et suivi celui-ci en tant que meilleure pratique.
- POST De l'OMI n'est pas conçu pour une mise à jour à tous. C'est bon pour la création des choses et de l'envoi de certains RPC, DDD commandes de style comme /api/cars/1/sell. Votre solution ressemble plus à un hack.
InformationsquelleAutor Madhusudan Joshi

Vous devez vous connecter pour publier un commentaire.