不定形JSONを受領する場合のモデルの型

Question

前提・実現したいこと

C# / .net core 3.1 でREST APIサーバを作成しています。
json中にある一部のjsonが不定形の場合のモデル内宣言がわかりません。

POSTが以下の形できますが、DataのValueのJSONは不定で、DBにはシリアライズしてテキストで登録します。
例：
{"ID": "abcde", "Data": {"hoge": "h1", "fuga": "h2"} }
{"ID": "abcde", "Data": {"StartDate": "2021-01-01", "EndDate": "2021-03-31"}}
{"ID":"mghyts", "Data":{"Expired": "2021-03-25"}}
このDataは、アプリソフトがメタデータとして利用しており、GetされるとDataのJSONをそのまま返します。

コントローラーは
[HttpPost]
public async void Add(AddRequest request)
{
...
}

モデルクラスの定義でDataをなにで宣言していいのかがわかりません。
public class AddRequest
{
string ID {get; set;}
... Data {get; set;}
}

Comments

[退会済みユーザー]

ASP.NET アプリの話なら、ASP.NET のタグをつけてください。

> DataのValueのJSONは不定で、

{ "name" : "value" } の name は Data で決まっていて、value が不定と理解していますが、その具体例を 2, 3 書いていただけませんか？　受け取って中身を見るまで value の中身は全く分からないのですか？　とすると、どうやって value の中の目的の情報を取得できるのですか？

[kencha]

タグのご指摘、ありがとうございます。
アプリソフトがメタデータとして利用しており、GetされるとJSONをそのまま返します。
サーバ側は内容に関知しません。

{"ID": "abcde", "Data": {"StartDate": "2021-01-01", "EndDate": "2021-03-31"}}
だったり
{"ID":"mghyts", "Data":{"Expired": "2021-03-25"}}
だったりが今のところ予定されています。

[退会済みユーザー]

上の情報は質問欄を編集して追記願います。このコメント欄は「質問への追記・修正」の場所ですし、初期画面では閉じているので見ない人もいますので。

> 予定されています。

予定ということは変更はできるのですか？　であれば、以下のような形にして、データがないところは null とか空白にするということはできないのですか？

{"ID": "abcde", "Data": {"StartDate": "2021-01-01", "EndDate": "2021-03-31", "Expired": null}}

[kencha]

ご指摘、ありがとうございます。編集いたしました

[退会済みユーザー]

今から変更はできるのですか？　たとえば、以下のような形にして、データがないところは null とか空白にするということはできないのですか？

{"ID": "abcde", "Data": {"StartDate": "2021-01-01", "EndDate": "2021-03-31", "Expired": null}}

[kencha]

全く違う２つの用途に使用され、データ形式もアプリ側都合で変更するためスキームを固定することができません。

[退会済みユーザー]

{ "name" : "value" } の name は Data で決まっているなら、JSON 文字列をパースして value を取得する方法はあります。それが質問者さんのケースで意味があるかどうかわかりませんが回答欄に紹介しておきます。

[kencha]

keyはDataで確定しています。当初は [JsonExtensionData] Dictionary<string, string>... もあるらしいとさぐったのですが、配列なりネストなりする可能性がありそうなので回避いたしました。
「System.Text.Json でオーバーフロー JSON を処理するか、JsonElement または JsonNode を使用する方法」
https://docs.microsoft.com/ja-jp/dotnet/standard/serialization/system-text-json-handle-overflow?pivots=dotnet-core-3-1　でいけるかなと試していますが、まだうまくいっていません。
ご紹介いただければ助かります。

Answer 1

SurferOnWww さんのご回答を参考にして試しました。

結論

public class AddRequest
{
  string ID {get; set;}
  System.Text.Json.JsonElement Data {get; set;}
}

でいけました。

ユニットテストで、JsonElementは直接生成できませんので、テストデータ作成も少し手間でした。

Comments

[退会済みユーザー]

なるほど、モデルバインディングが問題だと思っていたのですが、それは気が付きませんでした。まるまる定義不明でも、

public class AddRequest
{
System.Text.Json.JsonElement Data {get; set;}
}

とかでバインドできるのかもしれませんね。試してみます。

[退会済みユーザー]

JSON 文字列がまるまる定義不明の場合は上のコメントに書いたようなモデルは使えなくて、アクションメソッドの引数を以下のようにしてやれば OK でした。

public IActionResult Post([FromBody] JsonElement postedObject)

Answer 2

{ "name" : "value" } の name は Data で決まっているなら、JSON 文字列をパースして Data に対応する value を取得する方法はあります。それが質問者さんのケースで意味があるかどうかわかりませんが紹介しておきます。

.NET Core 3.x なら System.Text.Json の Deserialize メソッドで JSON 文字列を JsonElement 構造体のオブジェクトにデシリアライズし、その中から name が "Data" の value 値を再帰を使って JsonElement として取得できます。

具体例は以下の記事の「(2) JsonElement (System.Text.Json)」のサンプルコードを見てください。

JSON 文字列から指定した name の value を取得
http://surferonwww.info/BlogEngine/post/2021/02/11/find-value-by-name-in-json-string.aspx

Controller のアクションメソッドでの JSON 文字列の取得方法、取得した JsonElement から目的の情報を得るのがチャレンジかもしれませんが・・・

【追記】

取得した JsonElement は、中身は全く不定でも、バラすことはできます。具体例は以下の記事を見てください

System.Text.Json の JsonElement をパース (CORE)
http://surferonwww.info/BlogEngine/post/2021/02/08/parse-jsonelement-object-deserialized-by-deserialize-method-in-system-text-json.aspx