ASP.NET Web APIでPOSTされたXMLデータをXML形式で取得する方法

Question

実現したいこと

ASP.NET Web API を使用して、POSTされたXMLデータをクラスに取り込みたい。

POSTされたBody値をXML形式で取得しようとすると変数が NULL になってしまい取得することができません。
クラスは、XMLの構造にあわせてデータクラスを作成しました。
検索するとJSON形式で取得する方法は出てくるのですが、XML形式で取得する方法を見つけることができません。
どなたかご存じの方いらっしゃいませんでしょうか？

お手数をおかけしますが、どうぞよろしくお願い致します。

参考にさせて頂いたサイト
・ASP.NET Web API 2 を利用してシンプルなWebAPI アプリケーションを作成する - ASP.NET プログラミング
https://www.ipentec.com/document/csharp-asp-net-web-api-2-create-simple-application

POST送信したXMLデータ

POST http://localhost:9000/Default
Content-Type: application/xml
Accept: application/xml

<?xml version="1.0" encoding="UTF-8"?>
<sample code="1.0">
  <data>
    <id>100</id>
  </data>
  <value>
    <name>aaaa</name>
    <version>1.0.0</version>
  </value>
</sample>

該当のソースコード

// データクラス
[System.Xml.Serialization.XmlRoot("sample")]
public class SampleData
{
    [System.Xml.Serialization.XmlAttribute]
    public string code;

    [System.Xml.Serialization.XmlElement("data")]
    public Data data;

    [System.Xml.Serialization.XmlElement("value")]
    public Value value;
}

public class Data
{
    [System.Xml.Serialization.XmlElement("id")]
    public string id;
}

public class Value
{
    [System.Xml.Serialization.XmlElement("name")]
    public string name;

    [System.Xml.Serialization.XmlElement("version")]
    public string version;
}

public class DefaultController : ApiController
{
    public string Post([FromBody] SampleData value)
    {
        return "value";
    }
}

補足情報（FW/ツールのバージョンなど）

Visual Studio Community 2019
C#
ASP.NET
Web API
Postman

Comments

[dodox86]

JSONでもXMLでもPOSTメソッドで送られたHTTPリクエストのコンテントボディ部に内容がセットされているはずなのですから、そのコンテントボディ部をXML関連のクラスのLoad相当のメソッドで読み込めば良いのでは。そういう話ではなくて？でしょうか。

[退会済みユーザー]

xml 形式のデータを post 送信し、サーバー側のアクションメソッドの引数 value にモデルバインドしたいのですよね？

[yuniben00]

dodox86様
説明が不足しておりすみません。
リクエストのボディにXML形式の値を設定してPOST送信していますが、POSTメソッド内で処理を止めて引数valueの値を見るとNULLになっており取得できておりません。どのようにしたらXML形式で取得できるか質問させていただきました。

[yuniben00]

SurferOnWww様
説明が不足しておりすみません。
おっしゃる通りです。引数valueにモデルバインドをしたいです。

[dodox86]

＞質問者さん
PostmanでXMLを送信しているのであれば、送信時のHTTPリクエスト全体の内容を質問文中に追記すると、より適切な回答がいただけるかと思います。

[yuniben00]

dodox86様
ご指摘ありがとうございます。質問文を編集しました。

Answer 1

引数valueにモデルバインドをしたいです。

自分の環境 (Windows 10 Pro 64-bit, Visual Studio 2015 Update 3, .NET Framework 4.6.1, Web API 2) で試してみました。

(1) 質問者さんが書かれたコードの通りに、モデルのプロパティへの属性の付与に加えて、

(2) 要求ヘッダに Content-Type: application/xml; charset=UTF-8 の設定（下は Fiddler の画像。赤枠部分に注目）と、

(3) App_Start/WebApiConfig.cs への設定の追加が必要でした。

それで以下の通りモデルバインドできます。

以下の記事には content-type の設定だけで済みそうなことが書いてありますが、自分が試した限りでは上記 (1), (3) も必要でした。

How WebAPI does Parameter Binding
https://docs.microsoft.com/ja-jp/archive/blogs/jmstall/how-webapi-does-parameter-binding

【追記】

戻ってくるのは、上の Fiddler の画像の青枠の通り JSON 文字列になります。xml ではないので注意してください。（要求ヘッダの Accept に application/xml が含まれると応答は JSON ではなく XML になります）

Comments

[yuniben00]

SurferOnWww様
ご回答いただきありがとうございます。
画像通り設定することでXMLデータをクラスに取り込むことができました。
勉強になりました。また、わからないことがあれば質問させていただきます。