Is there a simple way to configure JSON.NET so that some DateTime fields will be formatted without time and other DateTime fields will still be formatted with time?
Example:
{ firstName: 'John', lastName : 'Doe', birthday: '1965-09-23' }
Add a comment
|
4 Answers
If you need this to only affect a particular field, create a converter type first:
public class OnlyDateConverter : IsoDateTimeConverter
{
public OnlyDateConverter()
{
DateTimeFormat = "yyyy-MM-dd";
}
}
and then add this attribute to whatever fields/properties you want this for:
[JsonConverter(typeof(OnlyDateConverter))]
8 Comments
Matt Johnson-Pint
Nice. I was just getting to write the same thing, but extending
DateTimeConverterBase. This is much cleaner!
Simon_Weaver
Apparently you should use
/ instead of dashes for the benefit of certain old browsers : blog.dygraphs.com/2012/03/javascript-and-dates-what-mess.html
Stephen Lautier
Should you make the property as a DateTime or as a string?
whyleee
You can also use predefined
Microsoft.Rest.Serialization.DateJsonConverter type from Microsoft.Rest.ClientRuntime package (it is installed together with Microsoft.AspNetCore.All package)
James L.
This did not work for me, I am still getting the time sent even if I decorate a model's property with this attribute.
|
Try adding this line to configure your Web API:
config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(
new IsoDateTimeConverter() { DateTimeFormat = "yyyy-MM-dd" });
1 Comment
Matt Johnson-Pint
That would have effect globally, not just on "some" fields, as requested.
Answer from Youssef works when using Newtonsoft.Json to serialize a single field in the model. But by default core uses System.Text.Json to serialize objects. The same thing can be achieved in core without Newtonsoft like so:
using System.Text.Json.Serialization;
internal class JsonOnlyDateConverter : JsonConverter<DateTime>
{
public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
{
return DateTime.ParseExact(reader.GetString()!, "yyyy-MM-dd", CultureInfo.InvariantCulture);
}
public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
{
writer.WriteStringValue(value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture));
}
}
And use it in your model:
using System.Text.Json.Serialization;
...
[JsonConverter(typeof(JsonOnlyDateConverter))]
public DateTime MyDateField { get; set; }
1 Comment
Mike O.
This is the right solution! To expand on it, instead of using this:
[JsonConverter(typeof(JsonOnlyDateConverter))] in you Program.cs or Startup.cs, add the following: builder.Services.AddControllers().AddJsonOptions(options => { options.JsonSerializerOptions.Converters.Add( new IsoDateNoTimeConverter()); });Yousesef's answer with the OnlyDateConverter is best. But here is one alternative:
private DateTime _birthday;
public string Birthday
{
get { return _birthday.ToString("yyyy-MM-dd"); }
set {
_birthday = DateTime.ParseExact(value, "yyyy-MM-dd",
CultureInfo.InvariantCulture);
}
}
Advantage - You don't need to bind the Newtonsoft.Json library to your classes.
Disadvantage - The property is now exposed as a string anywhere you use it, which can cause it's own set of problems.
answered May 1, 2013 at 19:26
Matt Johnson-Pint
244k75 gold badges468 silver badges621 bronze badges
1 Comment
RooSoft
I've considered that approach, but it may not be the best when computations could be involved between dates. Thanks anyways!