C#でPOSTを介してJSONを送信し、返されたJSONを受信しますか?


86

これが私の最初だけでなく、今までにJSONを使用して、時間であるSystem.NetWebRequest私のアプリケーションのいずれかで。私のアプリケーションは、以下のようなJSONペイロードを認証サーバーに送信することになっています。

{
  "agent": {                             
    "name": "Agent Name",                
    "version": 1                                                          
  },
  "username": "Username",                                   
  "password": "User Password",
  "token": "xxxxxx"
}

このペイロードを作成するために、私はJSON.NETライブラリを使用しました。このデータを認証サーバーに送信し、そのJSON応答を受信するにはどうすればよいですか?これが私がいくつかの例で見たものですが、JSONコンテンツはありません:

var http = (HttpWebRequest)WebRequest.Create(new Uri(baseUrl));
http.Accept = "application/json";
http.ContentType = "application/json";
http.Method = "POST";

string parsedContent = "Parsed JSON Content needs to go here";
ASCIIEncoding encoding = new ASCIIEncoding();
Byte[] bytes = encoding.GetBytes(parsedContent);

Stream newStream = http.GetRequestStream();
newStream.Write(bytes, 0, bytes.Length);
newStream.Close();

var response = http.GetResponse();

var stream = response.GetResponseStream();
var sr = new StreamReader(stream);
var content = sr.ReadToEnd();

しかし、これは私が過去に使用した他の言語を使用することと比較して多くのコードのようです。私はこれを正しく行っていますか?そして、JSON応答を取得して、解析できるようにするにはどうすればよいですか?

ありがとう、エリート。

更新されたコード

// Send the POST Request to the Authentication Server
// Error Here
string json = await Task.Run(() => JsonConvert.SerializeObject(createLoginPayload(usernameTextBox.Text, password)));
var httpContent = new StringContent(json, Encoding.UTF8, "application/json");
using (var httpClient = new HttpClient())
{
    // Error here
    var httpResponse = await httpClient.PostAsync("URL HERE", httpContent);
    if (httpResponse.Content != null)
    {
        // Error Here
        var responseContent = await httpResponse.Content.ReadAsStringAsync();
    }
}

2
WebClient.UploadString(JsonConvert.SerializeObjectobj(yourobj))またはHttpClient.PostAsJsonAsync
LB 2014年

回答:


136

コードは非常に単純で完全に非同期であるため、HttpClientライブラリを使用してRESTfulAPIをクエリしていることに気付きました。

(編集:明確にするために質問からJSONを追加する)

{
  "agent": {                             
    "name": "Agent Name",                
    "version": 1                                                          
  },
  "username": "Username",                                   
  "password": "User Password",
  "token": "xxxxxx"
}

投稿したJSON-Structureを表す2つのクラスがあり、次のようになります。

public class Credentials
{
    [JsonProperty("agent")]
    public Agent Agent { get; set; }

    [JsonProperty("username")]
    public string Username { get; set; }

    [JsonProperty("password")]
    public string Password { get; set; }

    [JsonProperty("token")]
    public string Token { get; set; }
}

public class Agent
{
    [JsonProperty("name")]
    public string Name { get; set; }

    [JsonProperty("version")]
    public int Version { get; set; }
}

POSTリクエストを実行する次のようなメソッドを使用できます。

var payload = new Credentials { 
    Agent = new Agent { 
        Name = "Agent Name",
        Version = 1 
    },
    Username = "Username",
    Password = "User Password",
    Token = "xxxxx"
};

// Serialize our concrete class into a JSON String
var stringPayload = await Task.Run(() => JsonConvert.SerializeObject(payload));

// Wrap our JSON inside a StringContent which then can be used by the HttpClient class
var httpContent = new StringContent(stringPayload, Encoding.UTF8, "application/json");

using (var httpClient = new HttpClient()) {

    // Do the actual request and await the response
    var httpResponse = await httpClient.PostAsync("http://localhost/api/path", httpContent);

    // If the response contains content we want to read it!
    if (httpResponse.Content != null) {
        var responseContent = await httpResponse.Content.ReadAsStringAsync();

        // From here on you could deserialize the ResponseContent back again to a concrete C# type using Json.Net
    }
}

5
完璧ですが、待っているTask.run(()は何ですか?
Hunter Mitchell

24
利益のために新しいスレッドを起動しているだけなので、同期CPUバウンドメソッドでTask.Runを使用しないでください。
スティーブンフォスター

2
JsonPropertyすべてのプロパティにを入力する必要はありません。ただ、Json.Net年代に建て使用CamelCasePropertyNamesContractResolverまたはカスタムNamingStrategyシリアル化プロセスをカスタマイズする
Seafish

6
補足:usingwithを使用しないでくださいHttpClient。参照:aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong
maxshuty

4
System.Net.Http.Formattingを使用すると、拡張メソッドが定義されます。 "await httpClient.PostAsJsonAsync(" api / v1 / domain "、csObjRequest)"
hB0 2018年

15

JSON.NET NuGetパッケージと匿名型を使用すると、他の投稿者が提案していることを単純化できます。

// ...

string payload = JsonConvert.SerializeObject(new
{
    agent = new
    {
        name    = "Agent Name",
        version = 1,
    },

    username = "username",
    password = "password",
    token    = "xxxxx",
});

var client = new HttpClient();
var content = new StringContent(payload, Encoding.UTF8, "application/json");

HttpResponseMessage response = await client.PostAsync(uri, content);

// ...

6

あなたは、あなたが構築することができますHttpContentの組み合わせを使用してJObject回避し、しJPropertyた後、呼び出しToString()構築する際、それにStringContent

        /*{
          "agent": {                             
            "name": "Agent Name",                
            "version": 1                                                          
          },
          "username": "Username",                                   
          "password": "User Password",
          "token": "xxxxxx"
        }*/

        JObject payLoad = new JObject(
            new JProperty("agent", 
                new JObject(
                    new JProperty("name", "Agent Name"),
                    new JProperty("version", 1)
                    ),
                new JProperty("username", "Username"),
                new JProperty("password", "User Password"),
                new JProperty("token", "xxxxxx")    
                )
            );

        using (HttpClient client = new HttpClient())
        {
            var httpContent = new StringContent(payLoad.ToString(), Encoding.UTF8, "application/json");

            using (HttpResponseMessage response = await client.PostAsync(requestUri, httpContent))
            {
                response.EnsureSuccessStatusCode();
                string responseBody = await response.Content.ReadAsStringAsync();
                return JObject.Parse(responseBody);
            }
        }

Exception while executing function. Newtonsoft.Json: Can not add Newtonsoft.Json.Linq.JProperty to Newtonsoft.Json.Linq.JArrayエラーを回避するにはどうすればよいですか?
Jari Turkia 2018

1
HttpClientインスタンスは、using構文で作成することは想定されていません。インスタンスは一度作成して、アプリケーション全体で使用する必要があります。これは、独自の接続プールを使用しているためです。あなたのコードは主にSocketExceptionをスローする傾向があります。docs.microsoft.com/en-us/dotnet/api/…–
Harun

2

HttpClient()で使用可能なPostAsJsonAsync()メソッドを使用することもできます

   var requestObj= JsonConvert.SerializeObject(obj);
   HttpResponseMessage response = await    client.PostAsJsonAsync($"endpoint",requestObj).ConfigureAwait(false);


1
コードの機能と問題の解決方法について説明を追加していただけますか?
NilambarSharma19年

投稿したいオブジェクトを取得し、SerializeObject()を使用してシリアル化できます。 var obj= new Credentials { Agent = new Agent { Name = "Agent Name", Version = 1 }, Username = "Username", Password = "User Password", Token = "xxxxx" }; そして、それをhttpContentに変換する必要なしに、PostAsJsonAsync()を使用して、エンドポイントURLと変換されたJSONオブジェクト自体を渡すことができます。
RukshalaWeerasinghe19年
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.