Wie übergebe ich ein Objekt an HttpClient.PostAsync und serialisiere es als JSON-Body?

Ich benutze System.Net.Http, ich habe mehrere Beispiele im Web gefunden. Ich habe es geschafft, diesen Code für eine POSTAnfrage zu erstellen :

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;
    }
 }

alles funktioniert gut. Angenommen, ich möchte einen dritten Parameter an die POSTMethode übergeben, einen Parameter namens data. Der Datenparameter ist ein Objekt wie das folgende:

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

wie kann ich das machen ohne das zu erstellen KeyValuePair? Mein PHP RestAPIwartet auf eine JSON-Eingabe, daher FormUrlEncodedContentsollte der rawJSON korrekt gesendet werden. Aber wie kann ich das machen Microsoft.Net.Http? Vielen Dank.

Die direkte Antwort auf Ihre Frage lautet: Nein. Die Signatur für die PostAsyncMethode lautet wie folgt:

öffentliche Aufgabe PostAsync (Uri requestUri, HttpContent-Inhalt)

Während Sie also ein übergeben können object, PostAsyncmuss es vom Typ sein HttpContentund Ihr anonymer Typ erfüllt diese Kriterien nicht.

Es gibt jedoch Möglichkeiten, das zu erreichen, was Sie erreichen möchten. Zunächst müssen Sie Ihren anonymen Typ in JSON serialisieren. Das häufigste Tool hierfür ist Json.NET . Und der Code dafür ist ziemlich trivial:

var myContent = JsonConvert.SerializeObject(data);

Als nächstes müssen Sie ein Inhaltsobjekt erstellen, um diese Daten zu senden. Ich werde ein ByteArrayContentObjekt verwenden, aber Sie können einen anderen Typ verwenden oder erstellen, wenn Sie möchten.

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

Als Nächstes möchten Sie den Inhaltstyp festlegen, damit die API weiß, dass es sich um JSON handelt.

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

Dann können Sie Ihre Anfrage, die Ihrem vorherigen Beispiel sehr ähnlich ist, mit dem Formularinhalt senden:

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

Nebenbei bemerkt kann das Aufrufen der .ResultEigenschaft, wie Sie es hier tun, einige schlimme Nebenwirkungen haben, wie z. B. Dead Locking. Sie sollten also vorsichtig damit sein.

Sie müssen Ihre Daten im Anforderungshauptteil als Rohzeichenfolge übergeben und nicht FormUrlEncodedContent. Eine Möglichkeit besteht darin, es in eine JSON-Zeichenfolge zu serialisieren:

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

Jetzt müssen Sie nur noch die Zeichenfolge an die post-Methode übergeben.

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);

Eine einfache Lösung ist die Verwendung Microsoft ASP.NET Web API 2.2 Clientvon NuGet .

Dann können Sie dies einfach tun und das Objekt wird in JSON serialisiert und der Content-TypeHeader wird auf Folgendes gesetzt 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);

Es gibt jetzt einen einfacheren Weg mit .NET Standardoder .NET Core:

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

HINWEIS: Um die JsonMediaTypeFormatterKlasse verwenden zu können, müssen Sie das Microsoft.AspNet.WebApi.ClientNuGet-Paket installieren, das direkt oder über ein anderes wie z Microsoft.AspNetCore.App.

Mit dieser Signatur von HttpClient.PostAsynckönnen Sie jedes Objekt übergeben und das JsonMediaTypeFormatterkümmert sich automatisch um die Serialisierung usw.

Mit der Antwort können Sie HttpContent.ReadAsAsync<T>den Antwortinhalt auf den erwarteten Typ deserialisieren:

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