HTTP POST Webリクエストを行う方法


1133

Canonical メソッド
を使用してHTTPリクエストを作成し、データを送信するにはどうすればよい POST ですか?

GET依頼はできますが、依頼の仕方がわかりませんPOST

回答:


2165

HTTP GETPOSTリクエストを実行する方法はいくつかあります。


方法A:HttpClient(推奨)

で利用可能:.NET Framework 4.5+.NET Standard 1.1+.NET Core 1.0+

これは現在推奨されるアプローチであり、非同期で高性能です。ほとんどの場合、組み込みバージョンを使用しますが、非常に古いプラットフォームにはNuGetパッケージがあります

using System.Net.Http;

セットアップ

HttpClient特定の理由がない限り、アプリケーションの存続期間中にインスタンス化して共有することをお勧めします。

private static readonly HttpClient client = new HttpClient();

依存関係注入ソリューションについてHttpClientFactoryは、を参照してください。


  • POST

    var values = new Dictionary<string, string>
    {
        { "thing1", "hello" },
        { "thing2", "world" }
    };
    
    var content = new FormUrlEncodedContent(values);
    
    var response = await client.PostAsync("http://www.example.com/recepticle.aspx", content);
    
    var responseString = await response.Content.ReadAsStringAsync();
    
  • GET

    var responseString = await client.GetStringAsync("http://www.example.com/recepticle.aspx");

方法B:サードパーティライブラリ

RestSharp

  • POST

     var client = new RestClient("http://example.com");
     // client.Authenticator = new HttpBasicAuthenticator(username, password);
     var request = new RestRequest("resource/{id}");
     request.AddParameter("thing1", "Hello");
     request.AddParameter("thing2", "world");
     request.AddHeader("header", "value");
     request.AddFile("file", path);
     var response = client.Post(request);
     var content = response.Content; // Raw content as string
     var response2 = client.Post<Person>(request);
     var name = response2.Data.Name;
    

Flurl.Http

流暢なAPIを備え、ヘルパーをテストし、内部でHttpClientを使用し、移植性の高い新しいライブラリです。NuGetから入手できます。

    using Flurl.Http;

  • POST

    var responseString = await "http://www.example.com/recepticle.aspx"
        .PostUrlEncodedAsync(new { thing1 = "hello", thing2 = "world" })
        .ReceiveString();
    
  • GET

    var responseString = await "http://www.example.com/recepticle.aspx"
        .GetStringAsync();
    

方法C:HttpWebRequest(新しい作業にはお勧めしません)

で利用可能:.NET Framework 1.1+.NET Standard 2.0+.NET Core 1.0+。.NET Coreでは、主に互換性のためHttpClientです。ラップし、パフォーマンスが低下し、新しい機能を利用できません。

using System.Net;
using System.Text;  // For class Encoding
using System.IO;    // For StreamReader

  • POST

    var request = (HttpWebRequest)WebRequest.Create("http://www.example.com/recepticle.aspx");
    
    var postData = "thing1=" + Uri.EscapeDataString("hello");
        postData += "&thing2=" + Uri.EscapeDataString("world");
    var data = Encoding.ASCII.GetBytes(postData);
    
    request.Method = "POST";
    request.ContentType = "application/x-www-form-urlencoded";
    request.ContentLength = data.Length;
    
    using (var stream = request.GetRequestStream())
    {
        stream.Write(data, 0, data.Length);
    }
    
    var response = (HttpWebResponse)request.GetResponse();
    
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    
  • GET

    var request = (HttpWebRequest)WebRequest.Create("http://www.example.com/recepticle.aspx");
    
    var response = (HttpWebResponse)request.GetResponse();
    
    var responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    

方法D:WebClient(新しい作業には推奨されません)

これはのラッパーHttpWebRequestです。と比較してくださいHttpClient

で利用可能:.NET Framework 1.1+NET Standard 2.0+.NET Core 2.0+

using System.Net;
using System.Collections.Specialized;

  • POST

    using (var client = new WebClient())
    {
        var values = new NameValueCollection();
        values["thing1"] = "hello";
        values["thing2"] = "world";
    
        var response = client.UploadValues("http://www.example.com/recepticle.aspx", values);
    
        var responseString = Encoding.Default.GetString(response);
    }
  • GET

    using (var client = new WebClient())
    {
        var responseString = client.DownloadString("http://www.example.com/recepticle.aspx");
    }

2
@ロイド:HttpWebResponse response = (HttpWebResponse)HttpWReq.GetResponse();
Evan Mulawski、2011年

2
なぜASCIIを使用するのですか?誰かがUTF-8のxmlを必要とする場合はどうなりますか?
下呂

8
私は死んだ馬を打つことを憎むが、あなたは行う必要がありますresponse.Result.Content.ReadAsStringAsync()
デヴィッド・S.

13
なぜWebRequestとWebClientはレガシーだと言ったのですか?MSDNは、それらが非推奨であるとか何かを言っていません。何か不足していますか?
Hiep 2015年

23
@Hiep:それらは非推奨ではなく、Webリクエストを行うための新しい(そしてほとんどの場合、より優れた、より柔軟な)方法があります。私の意見では、重要ではない単純な操作の場合、古い方法で十分ですが、それはあなた次第です。
Evan Mulawski、2015年

384

単純なGETリクエスト

using System.Net;

...

using (var wb = new WebClient())
{
    var response = wb.DownloadString(url);
}

単純なPOSTリクエスト

using System.Net;
using System.Collections.Specialized;

...

using (var wb = new WebClient())
{
    var data = new NameValueCollection();
    data["username"] = "myUser";
    data["password"] = "myPassword";

    var response = wb.UploadValues(url, "POST", data);
    string responseInString = Encoding.UTF8.GetString(response);
}

15
+1通常のPOSTの場合、そのような短いコードを用意するのは素晴らしいことです。
user_v

3
Tim-解決できないリテラルを右クリックすると、Resolveコンテキストメニューが表示されます。このメニューには、Usingステートメントを追加するためのアクションが含まれています。解決コンテキストメニューが表示されない場合は、最初に参照を追加する必要があります。
Cameron Wilby、2013年

回答がはるかに単純で明確であるため、私はあなたの回答を良いものとして受け入れました。
Hooch

13
POSTリクエストのレスポンス変数がバイト配列であることを追加したいと思います。文字列応答を取得するには、Encoding.ASCII.GetString(response);を実行するだけです。(System.Textを使用)
Sindre 2014年

1
さらに、ビット複合配列$ _POST ['user']を次のように送信できます。data ["user [username]"] = "myUsername"; data ["user [password]"] = "myPassword";
Bimal Poudel 16

68

MSDNにはサンプルがあります。

using System;
using System.IO;
using System.Net;
using System.Text;

namespace Examples.System.Net
{
    public class WebRequestPostExample
    {
        public static void Main()
        {
            // Create a request using a URL that can receive a post. 
            WebRequest request = WebRequest.Create("http://www.contoso.com/PostAccepter.aspx");
            // Set the Method property of the request to POST.
            request.Method = "POST";
            // Create POST data and convert it to a byte array.
            string postData = "This is a test that posts this string to a Web server.";
            byte[] byteArray = Encoding.UTF8.GetBytes(postData);
            // Set the ContentType property of the WebRequest.
            request.ContentType = "application/x-www-form-urlencoded";
            // Set the ContentLength property of the WebRequest.
            request.ContentLength = byteArray.Length;
            // Get the request stream.
            Stream dataStream = request.GetRequestStream();
            // Write the data to the request stream.
            dataStream.Write(byteArray, 0, byteArray.Length);
            // Close the Stream object.
            dataStream.Close();
            // Get the response.
            WebResponse response = request.GetResponse();
            // Display the status.
            Console.WriteLine(((HttpWebResponse)response).StatusDescription);
            // Get the stream containing content returned by the server.
            dataStream = response.GetResponseStream();
            // Open the stream using a StreamReader for easy access.
            StreamReader reader = new StreamReader(dataStream);
            // Read the content.
            string responseFromServer = reader.ReadToEnd();
            // Display the content.
            Console.WriteLine(responseFromServer);
            // Clean up the streams.
            reader.Close();
            dataStream.Close();
            response.Close();
        }
    }
}

何らかの理由で、大量のデータを送信していると機能し
ませんでした

26

これは、データをJSON形式で送受信する完全な動作例です。私はVisual Studio 2013 Express Edition を使用しました。

using System;
using System.Collections.Generic;
using System.Data;
using System.Data.OleDb;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.Web.Script.Serialization;

namespace ConsoleApplication1
{
    class Customer
    {
        public string Name { get; set; }
        public string Address { get; set; }
        public string Phone { get; set; }
    }

    public class Program
    {
        private static readonly HttpClient _Client = new HttpClient();
        private static JavaScriptSerializer _Serializer = new JavaScriptSerializer();

        static void Main(string[] args)
        {
            Run().Wait();
        }

        static async Task Run()
        {
            string url = "http://www.example.com/api/Customer";
            Customer cust = new Customer() { Name = "Example Customer", Address = "Some example address", Phone = "Some phone number" };
            var json = _Serializer.Serialize(cust);
            var response = await Request(HttpMethod.Post, url, json, new Dictionary<string, string>());
            string responseText = await response.Content.ReadAsStringAsync();

            List<YourCustomClassModel> serializedResult = _Serializer.Deserialize<List<YourCustomClassModel>>(responseText);

            Console.WriteLine(responseText);
            Console.ReadLine();
        }

        /// <summary>
        /// Makes an async HTTP Request
        /// </summary>
        /// <param name="pMethod">Those methods you know: GET, POST, HEAD, etc...</param>
        /// <param name="pUrl">Very predictable...</param>
        /// <param name="pJsonContent">String data to POST on the server</param>
        /// <param name="pHeaders">If you use some kind of Authorization you should use this</param>
        /// <returns></returns>
        static async Task<HttpResponseMessage> Request(HttpMethod pMethod, string pUrl, string pJsonContent, Dictionary<string, string> pHeaders)
        {
            var httpRequestMessage = new HttpRequestMessage();
            httpRequestMessage.Method = pMethod;
            httpRequestMessage.RequestUri = new Uri(pUrl);
            foreach (var head in pHeaders)
            {
                httpRequestMessage.Headers.Add(head.Key, head.Value);
            }
            switch (pMethod.Method)
            {
                case "POST":
                    HttpContent httpContent = new StringContent(pJsonContent, Encoding.UTF8, "application/json");
                    httpRequestMessage.Content = httpContent;
                    break;

            }

            return await _Client.SendAsync(httpRequestMessage);
        }
    }
}

8

ここには本当に良い答えがいくつかあります。WebClient()でヘッダーを設定する別の方法を投稿しましょう。APIキーの設定方法も示します。

        var client = new WebClient();
        string credentials = Convert.ToBase64String(Encoding.ASCII.GetBytes(userName + ":" + passWord));
        client.Headers[HttpRequestHeader.Authorization] = $"Basic {credentials}";
        //If you have your data stored in an object serialize it into json to pass to the webclient with Newtonsoft's JsonConvert
        var encodedJson = JsonConvert.SerializeObject(newAccount);

        client.Headers.Add($"x-api-key:{ApiKey}");
        client.Headers.Add("Content-Type:application/json");
        try
        {
            var response = client.UploadString($"{apiurl}", encodedJson);
            //if you have a model to deserialize the json into Newtonsoft will help bind the data to the model, this is an extremely useful trick for GET calls when you have a lot of data, you can strongly type a model and dump it into an instance of that class.
            Response response1 = JsonConvert.DeserializeObject<Response>(response);

便利、ありがとう。ところで、header-propertiesを設定する上記の手法は、古い(非推奨?)HttpWebRequestアプローチでも機能するようです。例:myReq.Headers [HttpRequestHeader.Authorization] = $ "Basic {credentials}";
Zeek2

6

このソリューションでは、標準の.NET呼び出しのみを使用します。

テスト済み:

  • エンタープライズWPFアプリケーションで使用されています。UIのブロックを回避するためにasync / awaitを使用します。
  • .NET 4.5以降と互換性があります。
  • パラメータなしでテストされます(舞台裏で「GET」が必要です)。
  • パラメータを使用してテストされます(舞台裏で「POST」が必要です)。
  • Googleなどの標準のWebページでテストされています。
  • 内部JavaベースのWebサービスでテストされています。

参照:

// Add a Reference to the assembly System.Web

コード:

using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Net;
using System.Net.Http;
using System.Threading.Tasks;
using System.Web;

private async Task<WebResponse> CallUri(string url, TimeSpan timeout)
{
    var uri = new Uri(url);
    NameValueCollection rawParameters = HttpUtility.ParseQueryString(uri.Query);
    var parameters = new Dictionary<string, string>();
    foreach (string p in rawParameters.Keys)
    {
        parameters[p] = rawParameters[p];
    }

    var client = new HttpClient { Timeout = timeout };
    HttpResponseMessage response;
    if (parameters.Count == 0)
    {
        response = await client.GetAsync(url);
    }
    else
    {
        var content = new FormUrlEncodedContent(parameters);
        string urlMinusParameters = uri.OriginalString.Split('?')[0]; // Parameters always follow the '?' symbol.
        response = await client.PostAsync(urlMinusParameters, content);
    }
    var responseString = await response.Content.ReadAsStringAsync();

    return new WebResponse(response.StatusCode, responseString);
}

private class WebResponse
{
    public WebResponse(HttpStatusCode httpStatusCode, string response)
    {
        this.HttpStatusCode = httpStatusCode;
        this.Response = response;
    }
    public HttpStatusCode HttpStatusCode { get; }
    public string Response { get; }
}

パラメータなしで呼び出すには(舞台裏で "GET"を使用):

 var timeout = TimeSpan.FromSeconds(300);
 WebResponse response = await this.CallUri("http://www.google.com/", timeout);
 if (response.HttpStatusCode == HttpStatusCode.OK)
 {
     Console.Write(response.Response); // Print HTML.
 }

パラメータを指定して呼び出すには(舞台裏で "POST"を使用):

 var timeout = TimeSpan.FromSeconds(300);
 WebResponse response = await this.CallUri("http://example.com/path/to/page?name=ferret&color=purple", timeout);
 if (response.HttpStatusCode == HttpStatusCode.OK)
 {
     Console.Write(response.Response); // Print HTML.
 }

6

これまでに見つけたシンプルな(ワンライナー、エラーチェックなし、応答待ちなし)ソリューション:

(new WebClient()).UploadStringAsync(new Uri(Address), dataString);‏

注意して使用してください!


5
それはかなり悪いです。いかなる種類のエラー処理もなく、デバッグが面倒なので、私はそれをお勧めしません。さらに、この質問にはすでにすばらしい答えがあります。
Hooch

1
@Hoochは、最良の回答ではなくても、この種の回答に関心を持つかもしれません。
MitulátBATI

これが役立つ唯一のコンテキストは、コードゴルフとC#でのゴルフです;)
Extragorey

4

Windows.Web.Http名前空間を使用する場合、POSTの場合は、FormUrlEncodedContentの代わりにHttpFormUrlEncodedContentを記述します。また、応答はHttpResponseMessageのタイプです。残りはエヴァン・ムラウスキが書いたとおりです。


4

流暢なAPIが必要な場合は、Tiny.RestClientを使用できます。NuGetで入手できます。

var client = new TinyRestClient(new HttpClient(), "http://MyAPI.com/api");
// POST
var city = new City() { Name = "Paris", Country = "France" };
// With content
var response = await client.PostRequest("City", city)
                           .ExecuteAsync<bool>();

1

なぜこれは完全に簡単ではないのですか?リクエストを実行しても結果は処理されず、特に処理されません。.NETのバグも含まれているようです。HttpClient.GetAsyncのバグで、TaskCanceledExceptionではなくWebExceptionがスローされるようにしてください。

私はこのコードで終わった:

static async Task<(bool Success, WebExceptionStatus WebExceptionStatus, HttpStatusCode? HttpStatusCode, string ResponseAsString)> HttpRequestAsync(HttpClient httpClient, string url, string postBuffer = null, CancellationTokenSource cts = null) {
    try {
        HttpResponseMessage resp = null;

        if (postBuffer is null) {
            resp = cts is null ? await httpClient.GetAsync(url) : await httpClient.GetAsync(url, cts.Token);

        } else {
            using (var httpContent = new StringContent(postBuffer)) {
                resp = cts is null ? await httpClient.PostAsync(url, httpContent) : await httpClient.PostAsync(url, httpContent, cts.Token);
            }
        }

        var respString = await resp.Content.ReadAsStringAsync();
        return (resp.IsSuccessStatusCode, WebExceptionStatus.Success, resp.StatusCode, respString);

    } catch (WebException ex) {
        WebExceptionStatus status = ex.Status;
        if (status == WebExceptionStatus.ProtocolError) {
            // Get HttpWebResponse so that you can check the HTTP status code.
            using (HttpWebResponse httpResponse = (HttpWebResponse)ex.Response) {
                return (false, status, httpResponse.StatusCode, httpResponse.StatusDescription);
            }
        } else {
            return (false, status, null, ex.ToString()); 
        }

    } catch (TaskCanceledException ex) {
        if (cts is object && ex.CancellationToken == cts.Token) {
            // a real cancellation, triggered by the caller
            return (false, WebExceptionStatus.RequestCanceled, null, ex.ToString());
        } else {
            // a web request timeout (possibly other things!?)
            return (false, WebExceptionStatus.Timeout, null, ex.ToString());
        }

    } catch (Exception ex) {
        return (false, WebExceptionStatus.UnknownError, null, ex.ToString());
    }
}

これは、GETまたはPOSTを実行しますが、postBuffernullかどうかによって異なります

成功がtrueの場合、応答は ResponseAsString

成功がfalseの場合は確認することができWebExceptionStatusHttpStatusCodeそしてResponseAsString何が悪かったのか確認するためにしようとします。


0

.netコアでは、次のコードを使用してポストコールを作成できます。ここでは、このコードにいくつかの追加機能を追加して、プロキシの背後でコードを機能させ、ネットワーク資格情報があればそれを使用できるようにします。また、ここで、あなたのメッセージ。これがすべてを説明し、コーディングに役立つことを願っています。

HttpClient client = GetHttpClient(_config);

        if (headers != null)
        {
            foreach (var header in headers)
            {
                client.DefaultRequestHeaders.TryAddWithoutValidation(header.Key, header.Value);
            }
        }

        client.BaseAddress = new Uri(baseAddress);

        Encoding encoding = Encoding.UTF8;


        var result = await client.PostAsync(url, new StringContent(body, encoding, "application/json")).ConfigureAwait(false);
        if (result.IsSuccessStatusCode)
        {
            return new RequestResponse { severity = "Success", httpResponse = result.Content.ReadAsStringAsync().Result, StatusCode = result.StatusCode };
        }
        else
        {
            return new RequestResponse { severity = "failure", httpResponse = result.Content.ReadAsStringAsync().Result, StatusCode = result.StatusCode };
        }


 public HttpClient GetHttpClient(IConfiguration _config)
        {
            bool ProxyEnable = Convert.ToBoolean(_config["GlobalSettings:ProxyEnable"]);

            HttpClient client = null;
            if (!ProxyEnable)
            {
                client = new HttpClient();
            }
            else
            {
                string ProxyURL = _config["GlobalSettings:ProxyURL"];
                string ProxyUserName = _config["GlobalSettings:ProxyUserName"];
                string ProxyPassword = _config["GlobalSettings:ProxyPassword"];
                string[] ExceptionURL = _config["GlobalSettings:ExceptionURL"].Split(';');
                bool BypassProxyOnLocal = Convert.ToBoolean(_config["GlobalSettings:BypassProxyOnLocal"]);
                bool UseDefaultCredentials = Convert.ToBoolean(_config["GlobalSettings:UseDefaultCredentials"]);

                WebProxy proxy = new WebProxy
                {
                    Address = new Uri(ProxyURL),
                    BypassProxyOnLocal = BypassProxyOnLocal,
                    UseDefaultCredentials = UseDefaultCredentials,
                    BypassList = ExceptionURL,
                    Credentials = new NetworkCredential(ProxyUserName, ProxyPassword)

                };

                HttpClientHandler handler = new HttpClientHandler { Proxy = proxy };
                client = new HttpClient(handler,true);
            }
            return client;
        }
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.