Newtonsoft serializer settings

benchmarks/DependencyFactory.cs

@@ -1,5 +1,6 @@
 using System;
 using JsonApiDotNetCore.Builders;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Query;
@@ -9,9 +10,9 @@ namespace Benchmarks
 {
     internal static class DependencyFactory
     {
-        public static IResourceGraph CreateResourceGraph()
+        public static IResourceGraph CreateResourceGraph(IJsonApiOptions options)
         {
-            IResourceGraphBuilder builder = new ResourceGraphBuilder();
+            IResourceGraphBuilder builder = new ResourceGraphBuilder(options);
             builder.AddResource<BenchmarkResource>(BenchmarkResourcePublicNames.Type);
             return builder.Build();
         }

benchmarks/Query/QueryParserBenchmarks.cs

@@ -23,7 +23,7 @@ public class QueryParserBenchmarks
         public QueryParserBenchmarks()
         {
             IJsonApiOptions options = new JsonApiOptions();
-            IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph();
+            IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph(options);
 
             var currentRequest = new CurrentRequest();
             currentRequest.SetRequestResource(resourceGraph.GetResourceContext(typeof(BenchmarkResource)));
@@ -57,13 +57,13 @@ private static QueryParameterParser CreateQueryParameterDiscoveryForAll(IResourc
             ISortService sortService = new SortService(resourceDefinitionProvider, resourceGraph, currentRequest);
             ISparseFieldsService sparseFieldsService = new SparseFieldsService(resourceGraph, currentRequest);
             IPageService pageService = new PageService(options, resourceGraph, currentRequest);
-            IOmitDefaultService omitDefaultService = new OmitDefaultService(options);
-            IOmitNullService omitNullService = new OmitNullService(options);
+            IDefaultsService defaultsService = new DefaultsService(options);
+            INullsService nullsService = new NullsService(options);
 
             var queryServices = new List<IQueryParameterService>
             {
-                includeService, filterService, sortService, sparseFieldsService, pageService, omitDefaultService,
-                omitNullService
+                includeService, filterService, sortService, sparseFieldsService, pageService, defaultsService,
+                nullsService
             };
 
             return new QueryParameterParser(options, queryStringAccessor, queryServices, NullLoggerFactory.Instance);

benchmarks/Serialization/JsonApiDeserializerBenchmarks.cs

@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using BenchmarkDotNet.Attributes;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Models;
 using JsonApiDotNetCore.Serialization;
@@ -32,7 +33,8 @@ public class JsonApiDeserializerBenchmarks
 
         public JsonApiDeserializerBenchmarks()
         {
-            IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph();
+            var options = new JsonApiOptions();
+            IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph(options);
             var targetedFields = new TargetedFields();
 
             _jsonApiDeserializer = new RequestDeserializer(resourceGraph, targetedFields);

benchmarks/Serialization/JsonApiSerializerBenchmarks.cs

@@ -1,5 +1,6 @@
 using System;
 using BenchmarkDotNet.Attributes;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Graph;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Managers;
@@ -24,7 +25,8 @@ public class JsonApiSerializerBenchmarks
 
         public JsonApiSerializerBenchmarks()
         {
-            IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph();
+            var options = new JsonApiOptions();
+            IResourceGraph resourceGraph = DependencyFactory.CreateResourceGraph(options);
             IFieldsToSerialize fieldsToSerialize = CreateFieldsToSerialize(resourceGraph);
 
             var metaBuilderMock = new Mock<IMetaBuilder<BenchmarkResource>>();
@@ -34,7 +36,7 @@ public JsonApiSerializerBenchmarks()
             var resourceObjectBuilder = new ResourceObjectBuilder(resourceGraph, new ResourceObjectBuilderSettings());
 
             _jsonApiSerializer = new ResponseSerializer<BenchmarkResource>(metaBuilderMock.Object, linkBuilderMock.Object,
-                includeBuilderMock.Object, fieldsToSerialize, resourceObjectBuilder, new CamelCaseFormatter());
+                includeBuilderMock.Object, fieldsToSerialize, resourceObjectBuilder, options);
         }
 
         private static FieldsToSerialize CreateFieldsToSerialize(IResourceGraph resourceGraph)

src/Examples/JsonApiDotNetCoreExample/Models/Gender.cs

@@ -0,0 +1,9 @@
+namespace JsonApiDotNetCoreExample.Models
+{
+    public enum Gender
+    {
+        Unknown,
+        Male,
+        Female
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Models/Person.cs

@@ -20,9 +20,12 @@ public sealed class Person : Identifiable, IIsLockable
         [Attr]
         public string LastName { get; set; }
 
-        [Attr]
+        [Attr("the-Age")]
         public int Age { get; set; }
 
+        [Attr]
+        public Gender Gender { get; set; }
+
         [HasMany]
         public List<TodoItem> TodoItems { get; set; }
 

src/Examples/JsonApiDotNetCoreExample/Startups/KebabCaseStartup.cs

@@ -0,0 +1,24 @@
+using JsonApiDotNetCore.Configuration;
+using Microsoft.AspNetCore.Hosting;
+using Newtonsoft.Json.Serialization;
+
+namespace JsonApiDotNetCoreExample
+{
+    /// <summary>
+    /// This should be in JsonApiDotNetCoreExampleTests project but changes in .net core 3.0
+    /// do no longer allow that. See https://github.com/aspnet/AspNetCore/issues/15373.
+    /// </summary>
+    public sealed class KebabCaseStartup : Startup
+    {
+        public KebabCaseStartup(IWebHostEnvironment env) : base(env)
+        {
+        }
+
+        protected override void ConfigureJsonApiOptions(JsonApiOptions options)
+        {
+            base.ConfigureJsonApiOptions(options);
+
+            ((DefaultContractResolver)options.SerializerSettings.ContractResolver).NamingStrategy = new KebabCaseNamingStrategy();
+        }
+    }
+}

src/Examples/JsonApiDotNetCoreExample/Startups/NoDefaultPageSizeStartup.cs

@@ -1,9 +1,5 @@
 using Microsoft.AspNetCore.Hosting;
-using Microsoft.Extensions.DependencyInjection;
-using JsonApiDotNetCoreExample.Data;
-using Microsoft.EntityFrameworkCore;
-using JsonApiDotNetCore.Extensions;
-using System.Reflection;
+using JsonApiDotNetCore.Configuration;
 
 namespace JsonApiDotNetCoreExample
 {
@@ -15,20 +11,11 @@ public sealed class NoDefaultPageSizeStartup : Startup
     {
         public NoDefaultPageSizeStartup(IWebHostEnvironment env) : base(env) { }
 
-        public override void ConfigureServices(IServiceCollection services)
+        protected override void ConfigureJsonApiOptions(JsonApiOptions options)
         {
-            var mvcBuilder = services.AddMvcCore();
-            services
-                .AddDbContext<AppDbContext>(options => options.UseNpgsql(GetDbConnectionString()), ServiceLifetime.Transient)
-                .AddJsonApi(options => {
-                    options.Namespace = "api/v1";
-                    options.IncludeTotalRecordCount = true;
-                    options.LoadDatabaseValues = true;
-                    options.AllowClientGeneratedIds = true;
-                    options.DefaultPageSize = 0;
-                },
-                discovery => discovery.AddAssembly(Assembly.Load(nameof(JsonApiDotNetCoreExample))),
-                mvcBuilder: mvcBuilder);
+            base.ConfigureJsonApiOptions(options);
+
+            options.DefaultPageSize = 0;
         }
     }
 }

src/Examples/JsonApiDotNetCoreExample/Startups/Startup.cs

@@ -6,8 +6,10 @@
 using Microsoft.EntityFrameworkCore;
 using JsonApiDotNetCore.Extensions;
 using System;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Query;
 using JsonApiDotNetCoreExample.Services;
+using Newtonsoft.Json.Converters;
 
 namespace JsonApiDotNetCoreExample
 {
@@ -37,21 +39,24 @@ public virtual void ConfigureServices(IServiceCollection services)
                         .EnableSensitiveDataLogging()
                         .UseNpgsql(GetDbConnectionString(), innerOptions => innerOptions.SetPostgresVersion(new Version(9,6)));
                 }, ServiceLifetime.Transient)
-                .AddJsonApi(options =>
-                {
-                    options.IncludeExceptionStackTraceInErrors = true;
-                    options.Namespace = "api/v1";
-                    options.DefaultPageSize = 5;
-                    options.IncludeTotalRecordCount = true;
-                    options.LoadDatabaseValues = true;
-                    options.ValidateModelState = true;
-                    options.EnableResourceHooks = true;
-                },
-                discovery => discovery.AddCurrentAssembly());
+                .AddJsonApi(ConfigureJsonApiOptions, discovery => discovery.AddCurrentAssembly());
+
             // once all tests have been moved to WebApplicationFactory format we can get rid of this line below
             services.AddClientSerialization(); 
         }
 
+        protected virtual void ConfigureJsonApiOptions(JsonApiOptions options)
+        {
+            options.IncludeExceptionStackTraceInErrors = true;
+            options.Namespace = "api/v1";
+            options.DefaultPageSize = 5;
+            options.IncludeTotalRecordCount = true;
+            options.LoadDatabaseValues = true;
+            options.ValidateModelState = true;
+            options.EnableResourceHooks = true;
+            options.SerializerSettings.Converters.Add(new StringEnumConverter());
+        }
+
         public void Configure(
             IApplicationBuilder app,
             AppDbContext context)

src/JsonApiDotNetCore/Builders/IResourceGraphBuilder.cs

@@ -1,5 +1,4 @@
 using System;
-using JsonApiDotNetCore.Graph;
 using JsonApiDotNetCore.Internal;
 using JsonApiDotNetCore.Internal.Contracts;
 using JsonApiDotNetCore.Models;
@@ -19,7 +18,6 @@ public interface IResourceGraphBuilder
         /// <param name="pluralizedTypeName">
         /// The pluralized name that should be exposed by the API. 
         /// If nothing is specified, the configured name formatter will be used.
-        /// See <see cref="IResourceNameFormatter" />.
         /// </param>
         IResourceGraphBuilder AddResource<TResource>(string pluralizedTypeName = null) where TResource : class, IIdentifiable<int>;
         /// <summary>
@@ -30,7 +28,6 @@ public interface IResourceGraphBuilder
         /// <param name="pluralizedTypeName">
         /// The pluralized name that should be exposed by the API. 
         /// If nothing is specified, the configured name formatter will be used.
-        /// See <see cref="IResourceNameFormatter" />.
         /// </param>
         IResourceGraphBuilder AddResource<TResource, TId>(string pluralizedTypeName = null) where TResource : class, IIdentifiable<TId>;
         /// <summary>
@@ -41,7 +38,6 @@ public interface IResourceGraphBuilder
         /// <param name="pluralizedTypeName">
         /// The pluralized name that should be exposed by the API. 
         /// If nothing is specified, the configured name formatter will be used.
-        /// See <see cref="IResourceNameFormatter" />.
         /// </param>
         IResourceGraphBuilder AddResource(Type entityType, Type idType, string pluralizedTypeName = null);
     }

src/JsonApiDotNetCore/Builders/JsonApiApplicationBuilder.cs

@@ -30,7 +30,7 @@ namespace JsonApiDotNetCore.Builders
     /// </summary>
     public class JsonApiApplicationBuilder
     {
-        public readonly JsonApiOptions JsonApiOptions = new JsonApiOptions();
+        private readonly JsonApiOptions _options = new JsonApiOptions();
         internal IResourceGraphBuilder _resourceGraphBuilder;
         internal bool _usesDbContext;
         internal readonly IServiceCollection _services;
@@ -46,13 +46,13 @@ public JsonApiApplicationBuilder(IServiceCollection services, IMvcCoreBuilder mv
         /// <summary>
         /// Executes the action provided by the user to configure <see cref="JsonApiOptions"/>
         /// </summary>
-        public void ConfigureJsonApiOptions(Action<JsonApiOptions> configureOptions) => configureOptions(JsonApiOptions);
+        public void ConfigureJsonApiOptions(Action<JsonApiOptions> configureOptions) => configureOptions(_options);
 
         /// <summary>
-        /// Configures built-in .net core MVC (things like middleware, routing). Most of this configuration can be adjusted for the developers need.
+        /// Configures built-in .NET Core MVC (things like middleware, routing). Most of this configuration can be adjusted for the developers' need.
         /// Before calling .AddJsonApi(), a developer can register their own implementation of the following services to customize startup:
         /// <see cref="IResourceGraphBuilder"/>, <see cref="IServiceDiscoveryFacade"/>, <see cref="IJsonApiExceptionFilterProvider"/>,
-        /// <see cref="IJsonApiTypeMatchFilterProvider"/>, <see cref="IJsonApiRoutingConvention"/> and <see cref="IResourceNameFormatter"/>.
+        /// <see cref="IJsonApiTypeMatchFilterProvider"/> and <see cref="IJsonApiRoutingConvention"/>.
         /// </summary>
         public void ConfigureMvc()
         {
@@ -76,7 +76,7 @@ public void ConfigureMvc()
                 options.Conventions.Insert(0, routingConvention);
             });
 
-            if (JsonApiOptions.ValidateModelState)
+            if (_options.ValidateModelState)
             {
                 _mvcBuilder.AddDataAnnotations();
             }
@@ -144,7 +144,7 @@ public void ConfigureServices()
             _services.AddScoped(typeof(IResourceQueryService<,>), typeof(DefaultResourceService<,>));
             _services.AddScoped(typeof(IResourceCommandService<,>), typeof(DefaultResourceService<,>));
 
-            _services.AddSingleton<ILinksConfiguration>(JsonApiOptions);
+            _services.AddSingleton<ILinksConfiguration>(_options);
             _services.AddSingleton(resourceGraph);
             _services.AddSingleton<IHttpContextAccessor, HttpContextAccessor>();
             _services.AddSingleton<IResourceContextProvider>(resourceGraph);
@@ -165,7 +165,7 @@ public void ConfigureServices()
 
             AddServerSerialization();
             AddQueryParameterServices();
-            if (JsonApiOptions.EnableResourceHooks)
+            if (_options.EnableResourceHooks)
                 AddResourceHooks();
 
             _services.AddScoped<IInverseRelationships, InverseRelationships>();
@@ -178,16 +178,16 @@ private void AddQueryParameterServices()
             _services.AddScoped<ISortService, SortService>();
             _services.AddScoped<ISparseFieldsService, SparseFieldsService>();
             _services.AddScoped<IPageService, PageService>();
-            _services.AddScoped<IOmitDefaultService, OmitDefaultService>();
-            _services.AddScoped<IOmitNullService, OmitNullService>();
+            _services.AddScoped<IDefaultsService, DefaultsService>();
+            _services.AddScoped<INullsService, NullsService>();
 
             _services.AddScoped<IQueryParameterService>(sp => sp.GetService<IIncludeService>());
             _services.AddScoped<IQueryParameterService>(sp => sp.GetService<IFilterService>());
             _services.AddScoped<IQueryParameterService>(sp => sp.GetService<ISortService>());
             _services.AddScoped<IQueryParameterService>(sp => sp.GetService<ISparseFieldsService>());
             _services.AddScoped<IQueryParameterService>(sp => sp.GetService<IPageService>());
-            _services.AddScoped<IQueryParameterService>(sp => sp.GetService<IOmitDefaultService>());
-            _services.AddScoped<IQueryParameterService>(sp => sp.GetService<IOmitNullService>());
+            _services.AddScoped<IQueryParameterService>(sp => sp.GetService<IDefaultsService>());
+            _services.AddScoped<IQueryParameterService>(sp => sp.GetService<INullsService>());
         }
 
         private void AddResourceHooks()
@@ -214,8 +214,7 @@ private void AddServerSerialization()
 
         private void RegisterJsonApiStartupServices()
         {
-            _services.AddSingleton<IJsonApiOptions>(JsonApiOptions);
-            _services.TryAddSingleton<IResourceNameFormatter>(new CamelCaseFormatter());
+            _services.AddSingleton<IJsonApiOptions>(_options);
             _services.TryAddSingleton<IJsonApiRoutingConvention, DefaultRoutingConvention>();
             _services.TryAddSingleton<IResourceGraphBuilder, ResourceGraphBuilder>();
             _services.TryAddSingleton<IServiceDiscoveryFacade>(sp => new ServiceDiscoveryFacade(_services, sp.GetRequiredService<IResourceGraphBuilder>()));