Le comportement par défaut est:
Si le paramètre est une primitive de type ( int, bool, double, ...), l' API Web cherche à obtenir la valeur de l' URI de la requête HTTP.
Pour les types complexes (votre propre objet, par exemple Person:), l'API Web essaie de lire la valeur à partir du corps de la requête HTTP.
Donc, si vous avez:
- un type primitif dans l'URI, ou
- un type complexe dans le corps
... alors vous n'avez pas à ajouter d'attributs (ni [FromBody]ni [FromUri]).
Mais, si vous avez un type primitif dans le corps , vous devez l'ajouter [FromBody]devant votre paramètre de type primitif dans votre méthode de contrôleur WebAPI. (Parce que, par défaut, WebAPI recherche des types primitifs dans l'URI de la requête HTTP.)
Ou, si vous avez un type complexe dans votre URI , vous devez ajouter [FromUri]. (Parce que, par défaut, WebAPI recherche par défaut des types complexes dans le corps de la requête HTTP.)
Types primitifs:
public class UsersController : ApiController
{
// api/users
public HttpResponseMessage Post([FromBody]int id)
{
}
// api/users/id
public HttpResponseMessage Post(int id)
{
}
}
Types complexes:
public class UsersController : ApiController
{
// api/users
public HttpResponseMessage Post(User user)
{
}
// api/users/user
public HttpResponseMessage Post([FromUri]User user)
{
}
}
Cela fonctionne tant que vous n'envoyez qu'un seul paramètre dans votre requête HTTP. Lors de l'envoi de plusieurs , vous devez créer un modèle personnalisé qui a tous vos paramètres comme ceci:
public class MyModel
{
public string MyProperty { get; set; }
public string MyProperty2 { get; set; }
}
[Route("search")]
[HttpPost]
public async Task<dynamic> Search([FromBody] MyModel model)
{
// model.MyProperty;
// model.MyProperty2;
}
À partir de la documentation de Microsoft pour la liaison de paramètres dans l'API Web ASP.NET :
Lorsqu'un paramètre a [FromBody], l'API Web utilise l'en-tête Content-Type pour sélectionner un formateur. Dans cet exemple, le type de contenu est "application / json" et le corps de la demande est une chaîne JSON brute (pas un objet JSON). Au plus un paramètre est autorisé à lire à partir du corps du message.
Cela devrait fonctionner:
public HttpResponseMessage Post([FromBody] string name) { ... }
Cela ne fonctionnera pas:
// Caution: This won't work!
public HttpResponseMessage Post([FromBody] int id, [FromBody] string name) { ... }
La raison de cette règle est que le corps de la requête peut être stocké dans un flux non mis en mémoire tampon qui ne peut être lu qu'une seule fois.