Comment passer un objet à HttpClient.PostAsync et le sérialiser en tant que corps JSON ?

Question

J'utilise System.Net.Http J'ai trouvé plusieurs exemples sur le web. J'ai réussi à créer ce code pour faire un POST demande :

public static string POST(string resource, string token)
{
    using (var client = new HttpClient())
    {
        client.BaseAddress = new Uri(baseUri);
        client.DefaultRequestHeaders.Add("token", token);

        var content = new FormUrlEncodedContent(new[]
        {
             new KeyValuePair<string, string>("", "")
        });

        var result = client.PostAsync("", content).Result;
        string resultContent = result.Content.ReadAsStringAsync().Result;
        return resultContent;
    }
 }

tout fonctionne bien. Mais supposons que je veuille passer un troisième paramètre à la fonction POST un paramètre appelé data . Le paramètre de données est un objet comme celui-ci :

object data = new
{
    name = "Foo",
    category = "article"
};

comment puis-je faire cela sans créer le KeyValuePair ? Mon php RestAPI attend une entrée json, donc le FormUrlEncodedContent devrait envoyer le raw json correctement. Mais comment puis-je faire cela avec Microsoft.Net.Http ? Merci.

Answer 1

La réponse directe à votre question est : non. La signature de l'acte de naissance de l'enfant. PostAsync est la suivante :

public Task PostAsync(Uri requestUri, HttpContent content)

Ainsi, alors que vous pouvez passer un object à PostAsync il doit être de type HttpContent et votre type d'anonymat ne répond pas à ces critères.

Cependant, il existe des moyens d'accomplir ce que vous voulez accomplir. Tout d'abord, vous devrez sérialiser votre type anonyme en JSON, l'outil le plus courant pour cela étant Json.NET . Et le code pour cela est assez trivial :

var myContent = JsonConvert.SerializeObject(data);

Ensuite, vous devrez construire un objet de contenu pour envoyer ces données, je vais utiliser un ByteArrayContent mais vous pouvez utiliser ou créer un autre type si vous le souhaitez.

var buffer = System.Text.Encoding.UTF8.GetBytes(myContent);
var byteContent = new ByteArrayContent(buffer);

Ensuite, il faut définir le type de contenu pour que l'API sache qu'il s'agit de JSON.

byteContent.Headers.ContentType = new MediaTypeHeaderValue("application/json");

Vous pouvez ensuite envoyer votre demande de manière très similaire à votre exemple précédent avec le contenu du formulaire :

var result = client.PostAsync("", byteContent).Result

D'ailleurs, l'appel de la .Result propriété comme vous le faites ici peut avoir quelques mauvais effets secondaires comme la fermeture à clé, il faut donc être prudent avec ça.

Answer 2

Nouvelle solution .NET 5 :

Dans .NET 5, une nouvelle classe a été introduite, appelée JsonContent qui dérive de HttpContent . Voir dans les documents de Microsoft

Cette classe possède une méthode statique appelée Create() qui prend un objet comme paramètre.

Utilisation :

var myObject = new
{
    foo = "Hello",
    bar = "World",
};

JsonContent content = JsonContent.Create(myObject);

HttpResponseMessage response = await _httpClient.PostAsync("https://...", content);

Answer 3

Vous devez transmettre vos données dans le corps de la requête sous la forme d'une chaîne brute plutôt que de FormUrlEncodedContent . Une façon de le faire est de le sérialiser en une chaîne JSON :

var json = JsonConvert.SerializeObject(data); // or JsonSerializer.Serialize if using System.Text.Json

Il ne vous reste plus qu'à passer la chaîne de caractères à la méthode post.

var stringContent = new StringContent(json, UnicodeEncoding.UTF8, "application/json"); // use MediaTypeNames.Application.Json in Core 3.0+ and Standard 2.1+

var client = new HttpClient();
var response = await client.PostAsync(uri, stringContent);

Answer 4

Une solution simple consiste à utiliser Microsoft ASP.NET Web API 2.2 Client de NuGet .

Vous pouvez alors simplement faire ceci et cela sérialisera l'objet en JSON et définira l'attribut Content-Type à l'en-tête application/json; charset=utf-8 :

var data = new
{
    name = "Foo",
    category = "article"
};

var client = new HttpClient();
client.BaseAddress = new Uri(baseUri);
client.DefaultRequestHeaders.Add("token", token);
var response = await client.PostAsJsonAsync("", data);

Answer 5

Il existe maintenant un moyen plus simple avec .NET Standard ou .NET Core :

var client = new HttpClient();
var response = await client.PostAsync(uri, myRequestObject, new JsonMediaTypeFormatter());

NOTE : Afin d'utiliser le JsonMediaTypeFormatter vous devrez installer la classe Microsoft.AspNet.WebApi.Client paquet NuGet, qui peut être installé directement, ou via un autre tel que Microsoft.AspNetCore.App .

En utilisant cette signature de HttpClient.PostAsync vous pouvez passer n'importe quel objet et l'option JsonMediaTypeFormatter se chargera automatiquement de la sérialisation, etc.

Avec la réponse, vous pouvez utiliser HttpContent.ReadAsAsync<T> pour désérialiser le contenu de la réponse au type que vous attendez :

var responseObject = await response.Content.ReadAsAsync<MyResponseType>();