C#のWebClientを使って特定のURLにデータをPOSTする方法を解説

WebClientとは

C#ではWebClientクラスを使用することで、Web APIとの間でデータの取得（GET）や送信（POST）を簡単に行うことができます。WebClientは、サーバーとの間でデータを送受信するための共通メソッドを提供しており、Web APIを利用する際に非常に手軽なクラスです。

なお、最近の開発ではWebClientの代わりにHttpClientを使用することも推奨されていますが、本記事ではWebClientによるPOST処理の基本を解説します。

WebClientクラスは内部的にWebRequestクラスを利用してリソースへアクセスします。また、WebRequest.RegisterPrefixメソッドで登録された任意のWebRequest派生クラスを使ってデータにアクセスすることも可能です。

名前空間：System.Net
アセンブリ：System.Net.WebClient.dll

UploadStringメソッドによるデータ送信

WebClientでデータをPOSTするには、UploadStringメソッドを使用します。このメソッドは、指定したリソースに対して文字列データを送信し、サーバーからのレスポンスを文字列として返します。

以下の例では、JSON形式のユーザーデータを「jsonplaceholder.typicode.com」の /posts エンドポイントにPOSTしています。

サンプルコード

class Program{
   public static void Main(){
      User user = new User();
      try{
         using (WebClient webClient = new WebClient()){
            webClient.BaseAddress = "https://jsonplaceholder.typicode.com";
            var url = "/posts";
            webClient.Headers.Add("user-agent", "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.2; .NET CLR 1.0.3705;)");
            webClient.Headers[HttpRequestHeader.ContentType] ="application/json";
            string data = JsonConvert.SerializeObject(user);
            var response = webClient.UploadString(url, data);
            var result = JsonConvert.DeserializeObject<object>(response);
            System.Console.WriteLine(result);
         }
      }
      catch (Exception ex){
         throw ex;
      }
   }
}
class User{
   public int id { get; set; } = 1;
   public string title { get; set; } = "First Data";
   public string body { get; set; } = "First Body";
   public int userId { get; set; } = 222;
}

コードのポイント

• BaseAddress：APIのベースURLを設定し、相対パスでエンドポイントを指定できるようにします。
• Headers：User-AgentとContentType（application/json）を設定し、JSONデータを送信できるようにします。
• JsonConvert.SerializeObject：UserオブジェクトをJSON文字列にシリアライズしてから送信します。

実行結果

上記のコードを実行すると、サーバーから以下のようなJSONレスポンスが返されます。新しく作成されたリソースのID（101）が割り当てられていることがわかります。

{
   "id": 101,
   "title": "First Data",
   "body": "First Body",
   "userId": 222
}

まとめ

WebClientのUploadStringメソッドを使えば、少ないコード量で特定のURLへデータをPOSTできます。ヘッダーの設定とJSONのシリアライズ・デシリアライズを組み合わせることで、Web APIとの連携を簡単に実装できます。より高度な制御が必要な場合は、HttpClientの利用も検討してみてください。