Qu'est-ce que le repos de façon à représenter une ressource opération de duplication dans l'URL?

J'ai API REST qui expose un grand complexe de ressources et je veux être en mesure de cloner cette ressource. Supposons que la ressource est exposée à /resources/{resoureId}

De cloner des ressources 10 je pouvais faire quelque chose comme.

  • GET /resources/10
  • POST /resources/ corps de contenant une copie de la représentation par GET /resources/10 sans l'id de sorte que le POST crée une nouvelle ressource.

Le problème avec cette approche est que la ressource est très vaste et complexe qu'elle ne fait pas vraiment de sens pour retourner une représentation complète au client et que le client renvoyer comme ça serait juste une perte totale de la bande passante, et de la cpu sur le serveur. Le clonage de la ressource sur le serveur est tellement plus facile si je veux le faire.

Je pourrais faire quelque chose comme POST /resources/10/clone ou POST resources/clone/10 mais ces deux approches se sentir mal parce que le verbe dans l'URL.

Ce qui est le plus "reposante/nouny" moyen de construire l'url qui peut être utilisé dans ce type de situation?

  • Honnêtement, je pense que c'est parfaitement ok pour juste ajouter /clone à la fin de l'url parce que "clone" est aussi un nom, et dans ce cas, la chose que vous êtes en train de créer.
InformationsquelleAutor ams | 2013-09-12
  1. 57

    Puisqu'il n'est pas de copier ou de méthode clone en HTTP, c'est à vous de décider ce que vous voulez faire. Dans ce cas, un POST semble parfaitement raisonnable, mais d'autres normes ont adopté des approches différentes:

    Deux de ces approches supposent que vous savez l'URI de destination. Votre exemple me semble pas une destination connue d'uri, de sorte que vous avez à peu près doit utilisation POST. Vous ne pouvez pas utiliser les METTRE ou COPIE parce que votre opération de création n'est pas idempotent.

    Si votre service définit POST /resources comme "créer une nouvelle ressource", alors pourquoi ne pas simplement définir une autre façon de spécifier la ressource autre que le corps de la POSTE? E. g. POST /resources?source=/resources/10 dont le corps est vide.

    • POST /ressources?source=/ressources/10 est exactement ce dont j'ai besoin.
    • Puis-je poser une question de base? Bien sûr, je peux, c'est AINSI! J'ai fait quelque chose de similaire, mais j'ai permis à un corps de requête avec des champs qui peuvent être modifiés lors de la copie et une sourceId. Quelle est la raison derrière la mise à la source dans la chaîne de requête?
    • Pour décider de la façon de trouver et interpréter le corps vous avez besoin d'un out-of-band de la communication. L'OP a corps comme ressource corps (sans emballage), de sorte que l'url était naturel pour l'out-of-band info. (Il pourrait aussi avoir été par exemple, à différents type de contenu.) Vous semblez être déjà d'emballage, de sorte que les paramètres de réglage sur votre wrapper est très bien.
    • C'est la question, je ne suis pas. Je suis à l'aide d'un champ sourceId dans le corps et je ne l'aime pas.
    • Lorsque j'utilise POST /resources?source=/resources/10, quelle est la "bonne" façon d'obtenir /resources/10 à l'intérieur de mon API? L'idée est d'appeler l'OBTENIR pour /resources/10 à l'intérieur de mon API ou est seulement un moyen d'obtenir la carte d'identité?
    • Bonne réponse, je voudrais utiliser POST /resources?sourceId=10 au lieu
    • il n'y a pas de "bonne façon" d'aussi loin que le REPOS des principes, parce que c'est un détail d'implémentation. Mais il est difficile d'imaginer une mise en œuvre où il serait logique de demander au serveur de faire un GET à lui-même. Une bonne conception de la dicte que, quelle que soit la logique de votre application pourrait faire en réponse à OBTENIR, vous devriez juste faire la même logique, dans ce cas, pour accéder à la ressource, et puis faire ce que le reste de votre mise en œuvre nécessite de faire une copie et de la carte vers une nouvelle URL.
    • belle réponse, POST /resources?copyOf=10

    InformationsquelleAutor Francis Avila
  2. 6

    La réponse de françois est un grand et probablement ce que vous cherchez. Cela étant dit, il n'est pas techniquement Reposante depuis (comme il le dit dans les commentaires) il repose sur le client de la prestation de la bande d'information. Puisque la question était "qu'est-ce que le repos" et pas "qu'est ce qu'un bon moyen de/la meilleure façon", qui m'a fait penser qu'il y est une bonne solution. Et je pense que ce qui suit est une bonne solution, même si je ne suis pas sûr que c'est forcément mieux dans la pratique.

    Tout d'abord, comme vous l'avez déjà identifié, OBTENIR suivie par la POSTE est la simple et évidente Reposant façon, mais il n'est pas efficace. Nous sommes donc à la recherche d'une optimisation, et nous ne devrions pas être trop surpris si il se sent un peu moins naturel que celui que la solution!

    Le POST + sourceId solution crée une URL spéciale - celle qui ne pas une ressource, mais à une instruction de faire quelque chose. Toutes les fois que vous vous trouvez créer une Url comme ça, il est utile d'envisager si vous pouvez travailler autour de la nécessité de le faire en définissant simplement plus de ressources.

    Nous voulons que la possibilité de copier 

    resources/10

    Que si nous trouvons une autre ressource:

    resources/10/copies

    ...et la définition de cette ressource est tout simplement "la collection de ressources qui sont des copies de ressources/10".

    Avec cette ressource définie, nous pouvons maintenant re-état de notre opération de copie en des termes différents - au lieu de dire "je veux que le serveur afin de copier les ressources/10", on peut dire "je veux ajouter une chose nouvelle à la collection de choses qui sont des copies de ressources/10".

    Cela semble étrange, mais il s'inscrit naturellement dans le REPOS de la sémantique. Par exemple, disons que cette ressource actuellement ressemble à ça (je vais utiliser une représentation JSON ici):

    []

    On peut juste mettre à jour qu'avec un POST ou d'un PATCH [1]:

    POST resources/copies/10
["resources/11"]

    Noter que tous que nous allons envoyer au serveur de métadonnées à propos d'une collection, de sorte qu'il est très efficace. On peut supposer que le serveur sait maintenant où trouver les données à copier, car cela fait partie de la définition de cette ressource. On peut aussi supposer que le client sait qu'il en résulte une nouvelle ressource a été créé à "ressources/11" pour la même raison.

    Avec cette solution, tout est clairement définie comme une ressource, et de tout ce qui a une URL canonique, et pas de bande d'information est requis par le client.

    En fin de compte, est-il la peine d'aller avec cet étrange sentiment solution juste pour le plaisir d'être plus Reposant? Que, probablement, dépend de votre projet. Mais il est toujours intéressant d'essayer et de structurer le problème différemment par la création de différentes ressources!

    [1] je ne sais pas si a de sens pour permettre d'OBTENIR sur le thème "ressources/10/copie". Évidemment, dès que la ressource d'origine ou d'une copie de ce changement, la copie n'est pas vraiment une copie plus et ne devrait pas être dans cette collection. Mise en œuvre-sage, je ne vois pas l'intérêt de surcharger le serveur avec le maintien de la piste, donc je pense que cela devrait être traitée comme une mise à jour seule ressource.

    • Hmm intéressant... Avez-vous mettre en œuvre cette? Avez-vous eu des commentaires w.r.t. la mise en œuvre?
    • aussi je crois que vous vouliez dire POST resources/10/copies/ au lieu de POST resources/copies/10 ?
    • Non, je n'ai pas eu la chance de la mettre en œuvre. Et honnêtement, je considère juste aller avec le style RPC POST que la plupart des gens utilisent pour cela. Il n'a pas d' pour pour être Reposant pour une bonne conception. Mais peut-être que cette approche pourrait être utile. Concernant l'URL, je n'ai pas trop mis beaucoup de pensée dans /10/copies vs /copies/10 mais je ne vois pas beaucoup de différence - c'est vraiment à l'opérateur de décider.
    • Je vois un problème avec ça. Si vous avez de telles copies de ressource, vous devez maintenir le lien entre les deux ressources (10 et 11) afin d'avoir des ressources/10/copies à remettre les copies. Il ajoute une complexité supplémentaire dans les objets qui pourrait ne pas être nécessaire. Et si vous n'avez pas maintenir ce lien et ressources/10/copie est un faux ressource (pas de retourner les copies), alors tout ce que nous avons fait, c'est de remplacer le /copie verbe avec un /des copies de nom
    • C'est un bon point, que j'ai adressée dans ma note de bas de page à la fin de ma réponse. Il peut être une ressource qui n'a tout simplement pas soutenir OBTENIR, si le réalisateur ne veut pas maintenir ce lien. À cet égard, c'est pas pire que n'importe quel autre copie de la solution. Mais elle a l'avantage que si vous ne voulez maintenir ce lien pour une raison quelconque, il y a une belle logique URL pour récupérer les copies.
    • Ouais, mais alors il n'est pas plus reposant que de /ressources/id/copie (avec un verbe) fondamentalement, c'est la même chose 😉 même si le mot de la fin est différente. Autre que cela, si vous gardez la piste, puis il sera vraiment reposant et c'est une bonne idée

    InformationsquelleAutor John B
  3. 4

    Je pense que POST /resources/{id} serait une bonne solution pour copier une ressource.

    Pourquoi?

    • POST /resources est la valeur par défaut RESTE-Standard pour CRÉER une nouvelle ressource
    • POST /resources/{id} ne devrait pas être possible dans la plupart des api REST, parce que l'id existe déjà - vous ne sera jamais de générer une nouvelle ressource avec vous (le client) de la définition de l'identité. Le serveur va définir l'id.

    Notez également que vous ne serez jamais copier la ressource Une ressource B. Donc, si vous voulez copier les ressources existantes avec l'id=10, quelques réponses de proposer ce genre de chose:

    POST /resources?sourceId=10

POST /resources?copyid=10

    mais c'est plus simple:

    POST /resources/10

    qui crée une copie de 10 - vous devez récupérer 10 de stockage, donc si vous ne le trouvez pas, vous ne pouvez pas copier = jeter un 404 not Found.

    Si elle n'existe pas, vous créez une copie de celui-ci.

    Donc, en utilisant cette idée, vous pouvez le voir, il ne fait pas de sens de le faire, la copie de certains b de ressources pour certains, une ressource:

    POST /resources?source=/resources/10
POST /resources-a?source=/resources-b/10

    Alors, pourquoi ne pas simplement utiliser le POST /ressources/{id}

    • Il va CRÉER une nouvelle ressource
    • La copie parent est défini par la {id}
    • La copie sera seulement sur la même ressource
    • C'est le plus RESTE-comme variante

    Que pensez-vous de cela?

    • Élégant, mais déroutant. Orthographe plus POST /ressources?copyId=10 semble plus clair et très facile à mettre en œuvre sur tous les côtés.
    InformationsquelleAutor iCodr8
  4. 2

    Vous voulez créer une copie d'une ressource spécifique. Mon Approche dans ce cas, serait d'utiliser le endpoint suivant :
    POST /resources/{id}/copy, lire "créer une copie de la ressource {id}"

    InformationsquelleAutor PhilippeAuriach
  5. 1

    Va juste mettre ça là, si cela peut aider quelqu'un.

    Nous avons eu un scénario similaire, où nous avons été la fourniture de "vm" comme une fonction de mise à l'échelle sur notre offre IaaS. Donc, si un utilisateur veut évoluer, ils auraient frappé POST: /vms/vm101 point de terminaison avec request_body être

    {"action": "clone", //Specifies action to take, since our users can do couple of other actions on a vm, like power_off/power_on etc.
 "body": {"name": [vm102, vm103, vm104] //Number of clones to make
          "storage": 50, ... //Optional parameters for specifying differences in specs one would want from the base virtual machine 
          }

    et 3 clones de vm101 viz. vm102, vm103 et vm104 serait spinned.

    InformationsquelleAutor AnukuL