正常系/異常系で異なる構造のjsonを返すAPIのレスポンスを一つのクラスで扱いたい

Question

前提

あるAPIと通信し、結果を返すモジュールを作成しています。
APIはjson形式で結果を返し、モジュール内でJson.NETを使ってエンティティクラスにデシリアライズを行っています。
モジュールでは複数のAPI呼び出しがあり、レスポンスのエンティティクラスは一つの抽象クラスを継承し、APIごとに作成しています。

発生している問題・エラーメッセージ

APIはリクエストを正常に処理すると、下記の様なレスポンスを返すのですが、

{
  "token": "abcdefghijklmnopqrstuvwxyz"
}

リクエストを処理できなかった場合、下記の様なレスポンスを返します。

[
  {
    "error_code": "E01",
    "error_information": "hogehoge"
  },
  {
    "error_code": "E02",
    "error_information": "mogemoge"
  }
]

どのAPIでもエラー時に返ってくるデータのフォーマットは同一なので、すべてのレスポンスクラスの親は下記のような実装になっています。

public abstract class Response
{
	public Error[] Errors { get; set; }

	public class Error
	{
		[JsonProperty("error_code")]
		public string ErrorCode { get; set; }

		[JsonProperty("error_information")]
		public string ErrorInformation { get; set; }
	}
}

各APIのレスポンスクラスはこのように実装しています。

public class HogeApiResponse : Response
{
	[JsonProperty("token")]
	public string Token { get; set; }
}

しかし、上記のコードでは、エラー時のJSONをデシリアライズできず、例外が発生してしまいます。

Newtonsoft.Json.JsonSerializationException: 'Cannot deserialize the current JSON array (e.g. [1,2,3]) into type 'toybox.Response' because the type requires a JSON object (e.g. {"name":"value"}) to deserialize correctly.
To fix this error either change the JSON to a JSON object (e.g. {"name":"value"}) or change the deserialized type to an array or a type that implements a collection interface (e.g. ICollection, IList) like List<T> that can be deserialized from a JSON array. JsonArrayAttribute can also be added to the type to force it to deserialize from a JSON array.

試したこと

エラーメッセージに従って、ResponseクラスにIEnumerable<Error>を実装したりJsonArrayをつけたりしてみましたが正常にデシリアライズはできませんでした。

実現したいこと

APIがエラーを返したとき、他のプロパティはNull等でも構わないのでError[]にエラー情報が格納された状態でデシリアライズを行いたいです。
実際のコードではジェネリック等使って型を識別しているので、なんとか一つのクラスへのデシリアライズで完結させたいと思っています。

検証用のコード

実際のコードでテストするのは時間がかかるので、コンソールアプリを一つ作ってテストしています。
同じ様な例外が飛びます。

using System.Collections.Generic;
using Newtonsoft.Json;

namespace toybox
{
	static class Program
	{
		static void Main(string[] args)
		{
			var r = JsonConvert.DeserializeObject<ResponseImpl>(@"[{""error_code"":""E01"",""error_information"":""hogemoge""}]");
		}
	}

	public abstract class Response
	{
		public List<Error> Errors { get; set; }

		public class Error
		{
			[JsonProperty("error_code")]
			public string ErrorCode { get; set; }

			[JsonProperty("error_information")]
			public string ErrorInformation { get; set; }
		}
	}

	public class ResponseImpl : Response
	{

	}
}

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

.NET Framework 4.5.2

Comments

[退会済みユーザー]

エラーメッセージにある 'toybox.Response' とは何ですか？

[uchu_beer]

デシリアライズしようとしているクラスの名前空間とクラス名です。
検証に使っているコードを追加しているのでご確認ください

[退会済みユーザー]

> @"[{""error_code"":""E01"",""error_information"":""hogemoge""}]"

これが変なのですが、そこはとりあえず置いといても、そもそも [ { ... },{ ... },{ ... } ] という形の JSON 文字列はデシリアライズきなくて、例えば { "name": [ { ... },{ ... },{ ... } ] } というような形の JSON 文字列する必要があると思います。

Answer 1

解決されたようですが気になったので調査しました。
JsonConverterを書けば何とかなりました。動いてはいますが正しいかはわかりません^^;

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.Linq;

namespace Questions315978
{
    class Program
    {
        static void Main()
        {
            var errorJson = @"
[
  {
    ""error_code"": ""E01"",
    ""error_information"": ""hogehoge""
  },
  {
    ""error_code"": ""E02"",
    ""error_information"": ""mogemoge""
  }
]".Trim();
            //var r0 = JsonConvert.DeserializeObject<Response.Error[]>(errorJson);
            var r1 = JsonConvert.DeserializeObject<HogeApiResponse>(errorJson);


            var successJson = @"
{
  ""token"": ""abcdefghijklmnopqrstuvwxyz""
}".Trim();
            var r2 = JsonConvert.DeserializeObject<HogeApiResponse>(successJson);
        }
    }

    public class ResponseJsonConverter : JsonConverter
    {
        public override bool CanConvert(Type objectType)
            => typeof(Response).IsAssignableFrom(objectType);

        public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
        {
            if (reader.TokenType == JsonToken.StartArray)
            {
                var jArray = JArray.Load(reader);
                var target = (Response)Activator.CreateInstance(objectType);
                target.Errors = jArray.Select(x => JsonConvert.DeserializeObject<Response.Error>(x.ToString())).ToArray();
                return target;
            }
            else
            {
                var jObject = JObject.Load(reader);
                var target = Activator.CreateInstance(objectType);
                serializer.Populate(jObject.CreateReader(), target);
                return target;
            }
        }
        public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
            => throw new NotImplementedException();
    }

    [JsonConverter(typeof(ResponseJsonConverter))]
    public abstract class Response
    {
        public Error[] Errors { get; set; }

        public class Error
        {
            [JsonProperty("error_code")]
            public string ErrorCode { get; set; }

            [JsonProperty("error_information")]
            public string ErrorInformation { get; set; }
        }
    }

    public class HogeApiResponse : Response
    {
        [JsonProperty("token")]
        public string Token { get; set; }
    }
}

---

ついでにSystem.Text.Json版もやってみたのですが、さらに自信ありません^^;

using System;
using System.Text.Json;
using System.Text.Json.Serialization;

namespace Questions315978
{
    class Program
    {
        static void Main()
        {
            var errorJson = @"
[
  {
    ""error_code"": ""E01"",
    ""error_information"": ""hogehoge""
  },
  {
    ""error_code"": ""E02"",
    ""error_information"": ""mogemoge""
  }
]".Trim();
            var options = new JsonSerializerOptions();
            options.Converters.Add(new ResponseJsonConverter());
            //var r0 = JsonSerializer.Deserialize<Response.Error[]>(errorJson);
            var r1 = JsonSerializer.Deserialize<HogeApiResponse>(errorJson, options);


            var successJson = @"
{
  ""token"": ""abcdefghijklmnopqrstuvwxyz""
}".Trim();
            var r2 = JsonSerializer.Deserialize<HogeApiResponse>(successJson, options);
        }
    }

    public class ResponseJsonConverter : JsonConverter<Response>
    {
        public override bool CanConvert(Type typeToConvert)
            => typeof(Response).IsAssignableFrom(typeToConvert);

        public override Response Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        {
            if (reader.TokenType == JsonTokenType.StartArray)
            {
                var target = (Response)Activator.CreateInstance(typeToConvert);
                target.Errors = JsonSerializer.Deserialize<Response.Error[]>(ref reader);
                return target;
            }
            else
            {
                // options渡すと当然StackOverflowException
                return (Response)JsonSerializer.Deserialize(ref reader, typeToConvert);
            }
        }
        public override void Write(Utf8JsonWriter writer, Response value, JsonSerializerOptions options)
            => throw new NotImplementedException();
    }

    // こうも書けるのだが派生に引き継がれないっぽいのと、
    // 優先度が高すぎてStackOverflowExceptionを抑えられない^^;
    //[JsonConverter(typeof(ResponseJsonConverter))] // ダメ！
    public abstract class Response
    {
        public Error[] Errors { get; set; }

        public class Error
        {
            [JsonPropertyName("error_code")]
            public string ErrorCode { get; set; }

            [JsonPropertyName("error_information")]
            public string ErrorInformation { get; set; }
        }
    }

    //[JsonConverter(typeof(ResponseJsonConverter))] // ダメ！
    public class HogeApiResponse : Response
    {
        [JsonPropertyName("token")]
        public string Token { get; set; }
    }
}

Answer 2

かなりイケてない実装ではありますが、下記のようにして一旦解決しました（納期も余裕ないので…）

var json = @"[{""error_code"":""E01"",""error_information"":""hogemoge""}]";
var r = JsonConvert.DeserializeObject<ResponseImpl>(
	json.StartsWith("[")
		? @"{""errors"":" + json + "}"
		: json);

Comments

[退会済みユーザー]

あたかも自己解決したように書いてありますが、それは私の回答そのものではないですか？

Answer 3

質問のコメントに書きましたが、そもそも [ { ... },{ ... },{ ... } ] という形の JSON 文字列はデシリアライズきなくて、{ "name": [ { ... },{ ... },{ ... } ] } というような形の JSON 文字列する必要があると思います。

例えばリクエストを処理できなかった場合に返す JSON 文字列を以下のようにできればデシリアライズできるはずです。

{
  "Errors" :
  [
    {
      "error_code": "E01",
      "error_information": "hogehoge"
    },
    {
      "error_code": "E02",
      "error_information": "mogemoge"
    }
  ]
}

検証してみましたが、クラス定義を以下のようにして（質問者さんのコードと等価のはず）、

public class ResponseImpl
{
    public string Token { get; set; }
    public List<Error> Errors { get; set; }
}

public class Error
{ 
    public string Error_code { get; set; }
    public string Error_information { get; set; }
}

以下の画像の通りデシリアライズできます。

Comments

[uchu_beer]

確かにあまり見ない形のJsonではあるんですが、下記コードだとデシリアライズ可能でしたので、Jsonとしておかしい形式というわけではないんだと思います…
```
var r = JsonConvert.DeserializeObject<List<Response.Error>>(@"[{""error_code"":""E01"",""error_information"":""hogemoge""}]");
```

ですが確かに
{"errors":[{～}]}の形式にするのが早そうですね