Json.Netでシリアル化するときにカスタムDateTime形式を指定する

Question

ASP.NET Web APIを使用して一部のデータを公開するAPIを開発しています。

APIの1つでは、クライアントはyyyy-MM-dd形式で日付を公開したいと考えています。このクライアントには非常に限定されているため、グローバル設定（例：GlobalConfiguration.Configuration.Formatters.JsonFormatter）を変更したくありません。そして私はそれを複数のクライアントのためのソリューションで開発しています。

私は考えることができソリューションの一つは、カスタムJSONコンバーターを作成してから、私は

例えばをカスタム書式を行うために必要なプロパティにそれを置くことです

これを実行する他の簡単な方法があるかどうかは疑問です。

Answer 1

あなたは正しい方向にあります。グローバル設定を変更することはできないと言ったので、次のベストは、あなたが提案したように、必要に応じてJsonConverter属性を適用することです。 Json.Netにはすでに日付書式を指定できるIsoDateTimeConverterが組み込まれています。残念ながら、JsonConverter属性を使用してフォーマットを設定することはできません。これは、属性の唯一の引数がタイプであるためです。ただし、簡単な解決策があります：IsoDateTimeConverterをサブクラス化し、サブクラスのコンストラクタで日付書式を指定します。必要に応じてJsonConverter属性を適用して、カスタムコンバーターを指定すると、すぐに使用できます。ここで必要なコード全体は次のとおりです。

class CustomDateTimeConverter : IsoDateTimeConverter 
{ 
    public CustomDateTimeConverter() 
    { 
     base.DateTimeFormat = "yyyy-MM-dd"; 
    } 
} 

あなたもそこに時間を持つ気にしない場合は、あなたもIsoDateTimeConverterをサブクラス化する必要はありません。デフォルトの日付形式はyyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK（source codeのように）です。

Answer 2

これは、グローバルの書式設定を変更せずに、一時IsoDateTimeConverterインスタンスでもを行うことができます。

string json = JsonConvert.SerializeObject(yourObject, 
    new IsoDateTimeConverter() { DateTimeFormat = "yyyy-MM-dd HH:mm:ss" }); 

これはparams JsonConverter[]引数を取るオーバーロードを使用しています。

Answer 3

も利用可能シリアライザ設定のオーバーロードのいずれかを使用します。タイプを取って

var json = JsonConvert.SerializeObject(someObject, new JsonSerializerSettings() { DateFormatString = "yyyy-MM-ddThh:mm:ssZ" }); 

それとも

var json = JsonConvert.SerializeObject(someObject, Formatting.Indented, new JsonSerializerSettings() { DateFormatString = "yyyy-MM-ddThh:mm:ssZ" }); 

オーバーロードでも使用可能ですが。

Answer 4

あなたは、このアプローチを使用することができます。

public class DateFormatConverter : IsoDateTimeConverter 
{ 
    public DateFormatConverter(string format) 
    { 
     DateTimeFormat = format; 
    } 
} 

そして、このようにそれを使用します。

class ReturnObjectA 
{ 
    [JsonConverter(typeof(DateFormatConverter), "yyyy-MM-dd")] 
    public DateTime ReturnDate { get;set;} 
} 

DateTimeFormat文字列は、ここで説明した.NETの書式文字列の構文を使用しています：それは何のためにhttps://docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings