HttpClientクラスを使ったjsonデータのPOSTについて

Question

お世話になっております。
C#のHttpClientクラスを使ってPOSTする場合、WebAPI側（ASP.NET WebAPI .NetFramework4.7.2）で受けるPOSTメソッドの引数の書き方によってはメソッドにアクセスできない（404エラー）になります。

HttpClientを使ったクライアント側サンプル（.Net Core コンソールアプリケーションにて）

var client = new HttpClient();
var content = new StringContent(json, Encoding.UTF8, "application/json");
var response = await client.PostAsync("http://localhost/api/person", content);

アクセス可能なPOSTメソッド（クラスで受け取る）

public HttpResponseMessage PostPerson(Person person)
{}

アクセス不可能なPOSTメソッド（プリミティブな型で受け取る）

public HttpResponseMessage PostPerson(string id, string name)
{}

補足

POSTMANを使った場合は上記どちらのケースでもアクセス可能で、むしろ下記のようにサーバー側を記述してもアクセス可能です

public HttpResponseMessage PostPerson(Person person, string id, string name)
{
  // personにもid, nameにも値が入る
}

HttpClientを使ったjsonデータのPOSTで、プリミティブな型で受ける方法はありますでしょうか？

追記

WebAPI及びクライアント側のフレームワーク情報を追記しました。
HttpClientの使用方法はusingを使わないように修正しました。

Comments

[退会済みユーザー]

.NET Framework なのか Core なのかとそのバージョンを書いてください。

[退会済みユーザー]

> （404エラー）になります。

404 に間違いないですか？　404 というのは要求はサーバーに届いたが指定された url にリソースが見つからないということなのですが・・・

あと、本題とは関係ないことですが質問のコードのように using 句を使って HttpClient の初期化と Dispose を繰り返すと socket の枯渇につながりますので止めましょう。

[ws12]

ご指摘ありがとうございます。
> 404 に間違いないですか？
404 NotFoundで間違いありません。

> .NET Framework なのか Core
今回はどちらか関係なさそう（HttpClient側の問題？）と推測しておりましたので省略しておりました。追記しておきます。

> using 句を使って HttpClient
HttpClientはインスタンスを使い回す、といったところですね。サンプルのため特に考慮せず、ネットで拾ったものを流用しておりました。こちらも念のため修正しておきますね。

Answer 1

.NET Framework 版の ASP.NET Web API のバインディングについては、詳しくは以下の記事、それからリンクを張った MSDN Blog の記事「How WebAPI does Parameter Binding」に書いてありますのでそちらを読んでもらうとして、要点を書きますと・・・

(1) Model Binding または Formatters を利用するという 2 つの方法があって、Web API の場合は、クエリ文字列からパラメータを取得する場合は Model Binding を、ボディから取得する場合は Formatter を使う。

(2) string などのプリミティブ型をアクションメソッドの引数にした場合、引数に属性が付与されてなければクエリ文字列からパラメータを探してモデルバインディングする。

(3) コンプレックス型（例：下に紹介した記事のコードの Hero クラス）の場合、デフォルトでは Formatter を使ってボディからパラメータを取得する。

さらに、MSDN Blog の記事に "The body can only be read once" と書いてある点にも要注意です。

ASP.NET Web API のバインディング
http://surferonwww.info/BlogEngine/post/2018/09/11/aspnet-web-api-parameter-binding.aspx

なので、「アクセス不可能なPOSTメソッド（プリミティブな型で受け取る）」の以下のようなメソッドで id と name にボディから値を得ることはできないということになります。

public HttpResponseMessage PostPerson(string id, string name)
{}

POSTMANを使った場合は上記どちらのケースでもアクセス可能で

それは何かの勘違いではないですか？ クライアント側は関係ないはずです。Fiddler などのキャプチャツールを使って調べてください。

Comments

[ws12]

ご回答ありがとうございます。
初歩的なミスをしており、POSTMANで送信していたものは、jsonデータ以外にクエリパラメータが付与されておりました。このクエリパラメータに反応していたようで、こちらを削除したところ、POSTMANでも404エラーとなり、プリミティブな型での受け取りはできませんでした。
そもそもASP.NET WebAPIで、bodyの値をそのようなパラメータで受けることはできないのですね。
またjsonでpostされたデータを[frombody]を付与したプリミティブな型で受けることもできないのですね。jsonでPOSTするなら素直にクラス定義して受けます。
記載いただいたWebサイトも大変参考になりました、ありがとうございました。
また合わせて下記MSのページも参考にしましたので、備忘録として記載させていただきます。
https://docs.microsoft.com/ja-jp/aspnet/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api