Supprimer plusieurs enregistrements à l'aide de REPOS

Qu'est-ce que le REST-ful moyen de la suppression de plusieurs éléments?

Mon cas d'utilisation, c'est que j'ai une épine Dorsale de la Collection dans laquelle j'ai besoin d'être en mesure de supprimer plusieurs éléments à la fois. Les options semblent être:

  1. Envoyer une demande de SUPPRESSION pour chaque enregistrement unique (ce qui semble être une mauvaise idée si il y a potentiellement des dizaines d'articles);
  2. Envoyer une demande de SUPPRESSION où les ID à supprimer sont enchaînés dans l'URL (c'est à dire, "/dossiers/1;2;3");
  3. Dans un non-RESTE façon, envoyez un personnalisé objet JSON contenant l'ID est marqué pour suppression.

Toutes les options sont moins qu'idéales.

Cela semble être une zone grise de la convention sur le REPOS.

InformationsquelleAutor Donald Taylor | 2014-02-18
  1. 64
    1. Est viable Reposant choix, mais a évidemment les limites que vous avez décrit.
    2. Ne pas le faire. Il serait peut être interprétée par des intermédiaires sens de “SUPPRIMER le (seul) des ressources à /records/1;2;3” — Ainsi, une réponse 2xx à ce qui peut leur causer de purger la mémoire cache de /records/1;2;3; pas purge /records/1, /records/2 ou /records/3; proxy un 410 réponse pour /records/1;2;3, ou d'autres choses qui ne font pas de sens à partir de votre point de vue.
    3. Ce choix est le meilleur, et peut être fait Paisiblement. Si vous êtes à la création d'une API et vous souhaitez autoriser les changements de masse de ressources, vous pouvez utiliser le RESTE pour le faire, mais exactement comment n'est pas immédiatement évident pour beaucoup. Une méthode consiste à créer une "demande de modification" de ressources (par exemple par l'Affichage d'un organisme tel que records=[1,2,3] à /delete-requests) et sondage à la création de la ressource (spécifiée par le Location en-tête de la réponse) pour savoir si votre demande a été acceptée, rejetée, est en cours ou terminée. Ceci est utile pour des opérations de longue durée. Une autre façon est de envoyer un PATCH demande à la liste des ressources, /records, dont le corps contient une liste de ressources et d'actions à effectuer sur ces ressources (quel que soit le format que vous voulez à l'appui). Ceci est utile pour des rapide des opérations où le code de réponse pour la demande peut indiquer le résultat de l'opération.

    Tout ce qui peut être réalisé alors que dans le respect des contraintes de REPOS, et, habituellement, la réponse est de faire le "problème" dans une ressource, et de lui donner une URL.

    Ainsi, les opérations par lots, telles que la suppression d'ici, ou de Poster à plusieurs éléments d'une liste, ou de faire la même modification à un éventail de ressources, peut être géré par la création d'un "traitement par lots" liste " et l'Affichage de votre nouvelle opération pour elle.

    N'oubliez pas, le REPOS n'est pas la seule façon de résoudre n'importe quel problème. “RESTE” est juste un style architectural et vous n'avez pas ont d'y adhérer (mais vous allez perdre certains avantages de l'internet si vous n'avez pas). Je vous suggère de regarder en bas de cette liste de L'API HTTP architectures et de choisir celle qui vous convient. Juste faire de vous conscient de ce que vous perdez si vous choisissez un autre type d'architecture, et de prendre une décision éclairée en fonction de votre cas d'utilisation.

    Il y a des mauvaises réponses à cette question sur Modèles pour le traitement des opérations par lots dans les services web REST? qui ont beaucoup trop de upvotes, mais doit être lu.

    • Selon le format de votre url/chaîne de requête, le serveur doit être en mesure de déterminer si DELETE /records/1;2;3 ou tout ce qui est unique ou multiple supprimer l'événement. DELETE /records?id=1;2;3;4&multi=1 par exemple?
    • Il n'est pas de votre serveur que vous avez à vous soucier, c'est intermédiaires, réseaux de diffusion de contenu, la mise en cache proxy, etc. L'internet est un système de couches. C'est la raison cela fonctionne si bien. Roy a déterminé les aspects du système ont été nécessaires à sa réussite, et nommé au REPOS. Si vous émettez une DELETE demande, ce qui se trouve entre la requestee et le serveur pense que d'une seule ressource, à l'URL spécifiée, est supprimé. Les chaînes de requête sont parties opaques de l'URL de ces appareils, de sorte qu'il n'a pas d'importance comment vous spécifiez votre API, ils ne sont pas au courant de cette connaissance ne peut donc pas se comporter différemment.
    • /dossiers/1;2;3 ne fonctionnera pas si vous avez beaucoup de ressources pour supprimer en raison des restrictions de longueur de URI
    • Note que si on envisage de SUPPRIMER et d'un corps définissant les ressources nécessaires pour la purge, que certains intermédiaires peuvent pas transférer le corps. En outre, certains clients HTTP ne peut pas ajouter un corps à SUPPRIMER. Voir stackoverflow.com/questions/299628/...
    • Je voudrais simplement indiquer que le passage d'un corps de requête avec un DELETE demande est interdite. Ne pas le faire. Si vous le faites, je vais manger à vos enfants. Nom Nom nom.
    • . o o ( il sait que j'ai des enfants )
    • stackoverflow.com/a/299696/409976 n'est pas d'accord avec votre "passage d'un corps de requête avec un DELETE demande est interdite" @NicholasShanks
    • Salut, et merci pour les commentaires. Par spec, oui il n'est pas interdit (veuillez noter toutefois que shelly commentaire sur cette reponse); mais Luke était en train de suggérer comment les OP pourraient définir son API. J'ai simplement suggéré que mon API serait l'état que l'envoi de il une demande de SUPPRESSION avec un corps a été interdit.
    • Le problème avec l'argument pour le #3, c'est qu'il porte la même peine que de contre-argument à l'encontre de #2. De la création à supprimer la ressource n'est pas quelque chose que proxy en amont permettra de savoir comment gérer - le même contre-argument qui est soulevée à l'encontre de l'approche #2.
    • Je comprends où vous venez, et vous êtes de droite, du milieu, les hommes ne savent pas que la création de cette ressource entraîne d'autres ressources en aller; mais d'autres ressources en aller tout le temps. Ce qui est important, c'est que le gars dans le moyen de ne pas faire la mauvaise chose, dans ce cas, même si ce qu'ils font n'est pas optimale.
    • PATCH est destiné à modifier un certains ressources -- restcookbook.com/HTTP%20Methods/patch, restful-api-design.readthedocs.io/en/latest/methods.html
    • Oui, et dans ce cas, il est en train de changer le certains ressources de la "liste des dossiers". N'oubliez pas qu'une collection est une ressource en elle-même, et son contenu est la liste de ses membres. De noter que la suppression d'un élément dans une collection qui n'est pas forcément supprimer la ressource référencée, mais qu'il .
    • désolé, je n'avais pas bien lu, il est dit: "envoyer un PATCH requête à la liste des ressources" en gras.
    • L'option 3 ont le même problème que pour l'option 2, n'est-ce pas? Je veux dire des intermédiaires non pas de purge /dossiers/1, /dossiers/2 ou /dossiers/3.
    • Vous avez raison — c'est un compromis, mais qui ne viole pas le REPOS. Même si l'intermédiaire n'a purger cette URL ou retourné résultats mis en cache pour l'instant supprimé Url, rien de mauvais va se passer, autres que les clients d'obtenir des données obsolètes (toutes les données sont obsolètes au moment où il atteint le client, de toute façon).
    • Lien vers "HTTP API architectures" ne fonctionne plus.
    • grâce fixe. Il est déplacé au moins 3 fois depuis que j'ai écrit cette réponse!
    • Je voudrais suggérer cet article: «le REPOS n'a jamais été à propos de CRUD» tyk.io/blog/repos-jamais-crud . Il m'a beaucoup aidé à la compréhension RESTE mieux. Il traite la masse/LOT problème de ressources, mais aussi beaucoup plus (par exemple, délais d'exécution des lots, les opérations de ressources pour des tâches longues, etc..). Donner un coup de feu

    InformationsquelleAutor Nicholas Shanks
  2. 15

    Si GET /records?filteringCriteria retourne un tableau de tous les enregistrements qui correspondent aux critères, alors DELETE /records?filteringCriteria pourrait supprimer tous ces enregistrements.

    Dans ce cas, la réponse à votre question serait DELETE /records?id=1&id=2&id=3.

    • Je suis arrivé à cette conclusion: il suffit de retourner le verbe ce que vous voulez faire. Je ne comprends pas comment ce qui se passe pour OBTENIR ne va pas pour le SUPPRIMER.
    • GET /records?id=1&id=2&id=3n' pas signifie “obtenir les trois enregistrements avec l'Id 1, 2 & 3”, il signifie “obtenir la seule ressource avec chemin d'accès d'URL /dossiers?id=1&id=2&id=3”, qui pourrait être une image d'un navet, un simple document texte contenant le nombre "42" en chinois, ou ne peut pas exister.
    • Considérez les points suivants: les deux séquentielle des demandes de /records?id=1 et /records?id=2 sont envoyés, et leurs réponses mises en cache par certaines intermédiaire (par exemple, votre navigateur ou de votre FAI). Si l'internet savais ce que votre demande de dire par cela, alors il va de soi qu'une demande de /records?id=1&id=2 pourrait être retournés par le cache simplement par la fusion (en quelque sorte) les deux résultats, il l'a déjà fait, sans avoir à demander au serveur d'origine. Mais ce n'est pas possible. /records?id=1&id=2 peut-être pas valide (seulement 1 ID autorisés par la demande) ou peut-être renvoyer quelque chose de complètement différent (un navet).
    • C'est une ressource de base problème de mise en cache. Si mon DBA muté à l'état directement, puis les caches sont maintenant hors de synchronisation. - Vous donner un exemple 410 retourné par l'intermédiaire, mais 410 est permanente des déménagements, lors de la SUPPRESSION d'un cache peut effacer son logement pour que les URL, mais il ne sera pas envoyer un ou 410 404, car il ne sait pas si un DBA n'a pas seulement mis la ressource immédiatement de nouveau de retour dans le pays d'origine.
    • J'ai vraiment pas d'accord. Si les résultats sont mis en cache, c'est la faute du serveur. Et si vous parlez de la conception de l'API, vous êtes, espérons-le, on écrit le code pour le serveur. Si vous utilisez id[]=1&id[]=2 ou id=1&id=2 dans la chaîne de requête pour représenter un tableau de valeurs, que la chaîne de requête ne représentent à peine que. Et je pense qu'il est extrêmement commun, & bonne pratique d'avoir la chaîne de requête représentent un filtre. En outre, si vous le permettez pour les suppressions et mises à jour, ne pas mettre en cache les GET demandes. Si vous le faites, les clients tiendra vicié de l'état.
    • vous m'avez mal compris, nos deux points ne sont pas incompatibles. Je suis en train de dire une ressource peut représenter quoi que ce soit le serveur veut, y compris une collection de deux éléments, mais les intermédiaires ne pas comprendre que /?id=1,2, produit une collection de /1 et /2 — cette connaissance est interne au serveur d'origine. Même clients ne devrait pas savoir cela, si vous êtes en utilisant l'hypertexte Paisiblement. Quand j'ai dit "ne signifie pas" dans mon commentaire d'origine, je faisais allusion à "partir de l'adresse HTTP du point de vue", et non pas à partir du serveur.
    • juste, c'est vrai que c'est interne au serveur, mais n'est pas une API RESTful juste une API? Nous avons pour définir un comportement & comment les clients de l'interface avec elle. GET api/records/1 pourrait renvoyer une image d'un navet, mais si nous disons qu'il doit retourner une représentation JSON d'un "record" de l'objet, les clients peuvent s'attendre à ce que. Un DELETE demande avec une chaîne de requête n'est pas pour pour représenter supprimer les enregistrements qui correspondent à un filtre, mais cela ne signifie pas qu'il ne peut pas / ne devrait pas. Cette approche d'atteindre le résultat souhaité sans casser Reposant contraintes, donc je pense que c'est une bonne solution.
    • Je suis d'accord avec tout ça :-). L'autre inconvénient d'avoir une liste d'Id dans l'URL, c'est que l'URI de la longueur est plus limitée dans le monde réel que la longueur du corps, qui peut être un problème si vous voulez la liste d'un demi-million Id.
    • vous avez raison, et j'ai eu ce problème avant. Certaines personnes configurer le serveur pour accepter les x-method-override en-tête et au lieu POST la demande avec x-www-form-urlencoded si ce problème peut survenir. Seulement quelques centaines de id peut causer des problèmes!
    • Je pense que le principal problème, c'est que les non-idempotent demande (spécialement de suppression et de mise à jour) doit être manipulé avec précaution quand il s'agit de l'exécution de requêtes sur plusieurs dossiers en même temps; principalement à cause sans précédent des cas limites et des erreurs.

    InformationsquelleAutor Martin Ždila
  3. 4

    Je pense que Mozilla Service de Stockage SyncStorage API v1.5 est un bon moyen pour supprimer plusieurs enregistrements à l'aide de REPOS.

    Supprime un ensemble de la collection.

    DELETE https://<endpoint-url>/storage/<collection>

    Supprime plusieurs Asf à partir d'une collection avec une seule requête.

    DELETE https://<endpoint-url>/storage/<collection>?ids=<ids>

    id: supprime les Asf de la collection dont les id qui sont dans la liste séparée par des virgules. Un maximum de 100 ids peuvent être fournis.

    Supprime l'ASF à l'emplacement donné.

    DELETE https://<endpoint-url>/storage/<collection>/<id>

    http://moz-services-docs.readthedocs.io/en/latest/storage/apis-1.5.html#api-instructions

    • Ce semble comme une bonne solution. Je suppose que si mozilla pense que c'est correcte, alors il doit en être ainsi? La seule question qui se pose alors est la gestion des erreurs. Supposons qu'ils passent ?id=1,2,3 et id 3 n'existe pas ne vous supprimez 1 et 2 répondent alors avec un 200, parce que le demandeur veut 3 disparu et il n'est pas là, donc il n'a pas d'importance? ou si ils sont autorisés à supprimer 1 mais pas 2 ... ne vous supprimez rien et répond avec une erreur ou avez-vous supprimer ce que vous pouvez et laissez les autres...
    InformationsquelleAutor bootsoon
  4. 2

    Cela semble être une zone grise de la convention sur le REPOS.

    Oui, pour l'instant j'ai seulement trouvé une API REST guide de conception qui mentionne les opérations par lots (tel qu'un lot de suppression): le l'api google guide de conception.

    Ce guide mentions la création de la "coutume" des méthodes qui peuvent être associés par l'intermédiaire d'une ressource à l'aide d'une virgule, par exemple https://service.name/v1/some/resource/name:customVerb, il mentionne aussi explicitement les opérations par lots comme des cas d'utilisation:

    Une méthode personnalisée peut être associé à une ressource, d'une collection ou d'un service. Il peut prendre un arbitraire de la demande et retourner un arbitraire de réponse, et prend également en charge le streaming de demande et de réponse. [...] Les méthodes personnalisées devraient utiliser HTTP verbe POST car il a la plus flexible de la sémantique [...] Pour la performance des méthodes critiques, il peut être utile de fournir lot personnalisé des méthodes pour réduire les par la demande de frais généraux.

    De sorte que vous pouvez effectuer les opérations suivantes selon api google guide:

    POST /api/path/to/your/collection:batchDelete

    ...pour supprimer un groupe d'éléments de votre collection de ressources.

    • Est une solution viable que la liste des éléments est communiquée au moyen d'un format JSON tableau?
    • oui, bien sûr. vous pouvez POSTER une charge utile dont les identifiants sont envoyés par l'intermédiaire d'un tableau json.
    InformationsquelleAutor B12Toaster
  5. 1

    Que j'ai laissé pour un commerce de gros de remplacement d'une collection, par exemple PUT ~/people/123/shoes où le corps est l'ensemble de la collection de la représentation.

    Cela fonctionne pour les petits enfants des collections d'articles où le client veut examiner un les éléments et taillez-certaines et d'en ajouter quelques autres, puis mettre à jour le serveur. Ils pourraient METTRE un regroupement vide pour supprimer tous.

    Cela signifierait GET ~/people/123/shoes/9 serait toujours dans le cache, même si une suppression, mais c'est juste un problème de mise en cache et ce serait un problème si une autre personne supprimé la chaussure.

    Mes données/systèmes Api de toujours utiliser les ETags par opposition à l'expiration du temps afin que le serveur est frappé sur chaque demande, et j'ai besoin de corriger la version du/la simultanéité des en-têtes de muter les données. Pour les Api qui sont en lecture seule et vue/rapport aligné, j'utilise de temps d'expiration pour réduire les coups sur l'origine, par exemple, un classement peut être bon pour 10 minutes.

    Pour beaucoup de grandes collections, comme ~/people, j'ai tendance à ne pas avoir besoin de plusieurs supprimer, le cas d'utilisation a tendance à ne pas découlent naturellement et de manière simple DELETE fonctionne très bien.

    À l'avenir, et avec l'expérience de la construction des Api REST et frapper les mêmes problèmes et les exigences, telles que l'audit, je serais enclin à utiliser uniquement des verbes GET et POST et de design autour d'événements, p. ex. après un changement d'adresse de l'événement, bien que je soupçonne que vais venir avec son propre ensemble de problèmes 🙂

    Je voudrais aussi permettre avant la fin de l'devs pour construire leur propre Api qui consomment plus strictes back-end Api puisqu'il est souvent pratique, valide côté client raisons pourquoi ils n'aiment pas stricte, "mise en service zélote" API REST de design, et pour la productivité et le cache de la superposition des raisons.

    • J'ai adoré cette réponse droit jusqu'à ce que j'ai lu la dernière phrase 🙂 je n'ai jamais vu un cas d'utilisation où l'application stricte de REPOS a eu un net effet néfaste. Sûr qu'il peut faire pour plus de code à écrire, à ses deux extrémités, mais vous vous retrouvez avec un plus sûr, plus propre, moins du système couplé.
    • Haha. Il est devenu un modèle! Backend pour le front-end, il est appelé sur ThoughtWorks la technologie radar. Il permet aussi plus de l'application de la logique de l'écrit qui serait lourd de dire, JavaScript, et, évidemment, peut être mis à jour sans qu'un client afin de mettre à jour le dis, pour une application iOS.
    • Écrémé-la lecture des quatre premiers hits de Google, il semble que cette BFF technique ne peut fonctionner que lorsque les clients sont sous votre contrôle. Le client développeurs de développer l'API qu'ils veulent, cartographie des appels à microservice Api qui est la vraie fin. Dans ce schéma: samnewman.io/patterns/architecture/bff/#bff je place le "Périmètre" de la ligne ci-dessous, la BFF de boîtes, chaque boîte est tout simplement partie du client. Il pourrait même vivre à l'extérieur du centre de données sur le logement de la microservices. Aussi, je ne vois pas comment le REPOS ne s'applique pas à ces deux interfaces (client/BFF et BFF/microservice).
    • Ouais c'est un bon point. Il est généralement lorsque vous avez une équipe de construction de microservices et une équipe de prise angulaire app, par exemple, et que l'équipe de développement sont de plus avant la fin de types qui n'aiment pas avoir à travailler contre un tas de peu puriste services. Bien que je ne vois aucune raison pour laquelle vous ne pouvez pas utiliser le même modèle pour l'abstraction des microservices et l'agrégation dans une plus utilisable en façade pour vos clients, tels que les microservices peut être modifié sans impact sur la façade.
    • Une API de point de terminaison doit modéliser les besoins du domaine et des affaires. Code de résoudre ces problèmes et éviter la sur-l'ingénierie de respecter de strictes et beaucoup de temps inflexible specs. RESTE n'est rien, mais les lignes directrices de toute façon.
    InformationsquelleAutor Luke Puplett
  6. 0

    Si vous voulez envoyer plus d'un paramètre dans la Méthode HTTP DELETE de RESTAPI comme POST, GET, PUT alors essayez ceci :

    DELETE /app/module/test HTTP/1.1
Host: xxx.xxx.x.xx
ACCESS-TOKEN: xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: text/plain
Cache-Control: no-cache
Postman-Token: 3eabfb52-fdb2-4b05-aefa-b2fb0c53c247

first_name=name1&last_name=name2&mobile_no=2222222222&email_id=try@domain.com

    chaque valeur séparés par des

    & (et signer)

    et le Type de Contenu est text/plain OU texte comme vous le souhaitez.

    Il apparaîtra dans l'envoi d'une demande au facteur.

    et j'ai reçu la réponse du serveur comme

    Et ces réponses sont parvenues à partir du serveur qui ressemblait à ça sur le facteur.

    Array
(
    [first_name] => name1
    [last_name] => name2
    [mobile_no] => 2222222222
    [email_id] => try@domain.com
)
    InformationsquelleAutor Ashish Patidar