Ce qui est actuellement recommandé d'effectuer des mises à jour partielles avec l'API Web?

Je me demandais comment mettre en œuvre des mises à jour partielles avec ASP.NET Web API RESTful de l'interface? Par exemple, disons que nous sommes les objets de passage sur le fil de la structure suivante:

public class Person {
    public int Id { get; set; }
    public string Username { get; set; }
    public string Email { get; set; }
}

Comment pourrait-on charge la mise à jour de parties de Person à un moment, par exemple la Email propriété? Est-il recommandé de mettre en œuvre cette via OData et le PATCH verbe, ou serait-il mieux de mettre en œuvre PATCH soi-même?

HTTP PATCH il est

InformationsquelleAutor aknuds1 | 2013-01-05

31

Il n'y a pas de support dans le courant de la dernière stable version de l'API Web (à partir d'août 2012). Donc, si vous voulez utiliser est l'API Web RTM, pour la mise en œuvre de l'ensemble de la plomberie vous-même.

Avec cela dit, OData version préliminaire du package prend en charge les mises à jour partielles très bien par le biais de la nouvelle Delta<T> objet.
Actuellement le Microsoft.AspNet.WebApi.OData paquet est au RC de la version (0.3) et peut être obtenu à partir d'ici: http://www.nuget.org/packages/Microsoft.AspNet.WebApi.OData

Une fois que vous installez, vous pouvez ensuite l'utiliser en conséquence:
```
[AcceptVerbs("PATCH")]
public void Patch(int id, Delta<Person> person)
{
    var personFromDb = _personRepository.Get(id);
    person.Patch(personFromDb);
    _personRepository.Save();
}
```
Et vous souhaitez appeler de la part du client, comme ceci:
```
$.ajax({
    url: 'api/person/1',
    type: 'PATCH',
    data: JSON.stringify(obj),
    dataType: 'json',
    contentType: 'application/json',
    success: function(callback) {            
       //handle errors, do stuff yada yada yada
    }
});
```
L'avantage évident de cette est que cela fonctionne pour n'importe quelle propriété, et vous n'avez pas de soins si vous mettez à jour Email ou Username ou autres joyeusetés.

Vous pouvez également regarder dans ce post, car il montre une technique similaire http://techbrij.com/http-patch-request-asp-net-webapi

MODIFIER (plus d'info):
Afin de simplement utiliser le PATCH, vous n'avez pas besoin d'activer quelque chose OData liées, sauf pour l'ajout de la OData package - pour obtenir l'accès à la Delta<TEntityType> objet.

Vous pouvez alors faire ceci:
```
public class ValuesController : ApiController
{
    private static List<Item> items = new List<Item> {new Item {Id = 1, Age = 1, Name = "Abc"}, new Item {Id = 2, Age = 10, Name = "Def"}, new Item {Id = 3, Age = 100, Name = "Ghj"}};

    public Item Get(int id)
    {
        return items.Find(i => i.Id == id);
    }

    [AcceptVerbs("PATCH")]
    public void Patch(int id, Delta<Item> item)
    {
        var itemDb = items.Find(i => i.Id == id);
        item.Patch(itemDb);
    }
}
```
Si votre article est, disons le:
```
{
    "Id": 3,
    "Name": "hello",
    "Age": 100
}
```
Vous pouvez PATCH pour /api/values/3 avec:
```
{
    "Name": "changed!"
}
```
et qui sera correctement mise à jour de votre objet.

Delta<TEntity> permettra de garder une trace des changements pour vous. C'est une classe dynamique qui agit comme un léger proxy pour votre Type et comprendre les différences entre l'objet d'origine (c'est à dire à partir de la DB) et celui transmis par le client.

Cela n'affectera PAS le reste de votre API en aucun cas (sauf bien sûr le remplacement de la Dll avec les plus récents afin de faciliter la OData les dépendances de package).

J'ai ajouté un exemple de projet pour démontrer le travail de PATCH + Delta - vous pouvez le saisir ici (il.s VS2012) https://www.dropbox.com/s/hq7wt3a2w84egbh/MvcApplication3.zip
- J'ai regardé dans OData comme un moyen d'obtenir du soutien pour le PATCH. Cependant, est-il possible de simplement faire usage de Delta + PATCH sans la mise en œuvre du protocole OData en général? Je ne suis pas intéressé à faire un OData API, je veux juste le PATCH de soutien.
- pas de Delta<T> ne fonctionne pas sans le ODataMediaTypeFormatter, donc il faut au moins ajouter le oData paquet et l'appel de configuration.EnableOData(GetEdmModel()); Plus d'infos ici: blogs.msdn.com/b/alexj/archive/2012/11/02/....
- Mais comment cet impact sur mon API REST dans la pratique? Il travaillera selon le protocole OData, ou puis-je appliquer le PATCH sans les adapter mes publications de l'API à OData?
- en fait, mon commentaire a été mal 🙂 vous POUVEZ utiliser le Patch+Delta sans activer OData bits. Le Delta<T> est juste un proxy qui conserve la trace des dépendances. J'ai édité la réponse et l'ajout d'un exemple de projet
- Ce n'est pas de travail pour moi en ce moment, est-ce brisées après la mise à jour de la OData paquet? Le code s'exécute et je peux étape dans la méthode dans le débogueur, mais le patch ne s'applique pas à tous les changements.
- Peut-être que vous devriez vous dire que cela fonctionne uniquement pour les non-types de données primitifs. Il est impossible de patch int valeur (Âge de la majorité dans la démo).
- Cela fonctionne ou pas pour les int?
- Ne fonctionne pas avec la dernière version stable de WebAPI 2 communiqué. Honnêtement, je ne veux pas apporter ODataMediaTypeFormatter j'ai besoin d'JSON.NET. Je dirais upvoting cette fonction de demande: aspnetwebstack.codeplex.com/workitem/777
- Cette SORTE de réponse est de Youssef Moussaoui, qui je crois a travaillé sur l'API Web de Microsoft: stackoverflow.com/a/14734273/216440 . Il stipule que Delta<T> est conçu pour fonctionner uniquement avec OData et si cela fonctionne avec tous les autres médias formateur qui est par accident plutôt que par la conception.
InformationsquelleAutor Filip W

Vous devez vous connecter pour publier un commentaire.