feat(#1): hyphenated routes

Author: jaredcnance

README.md

@@ -108,7 +108,7 @@ public class ThingsController : JsonApiController<Thing>
 }
 ```
 
-#### Non-Integer Type Keys
+### Non-Integer Type Keys
 
 If your model is using a type other than `int` for the primary key,
 you should explicitly declare it in the controller
@@ -125,4 +125,24 @@ public class ThingsController : JsonApiController<Thing, Guid>
     : base(jsonApiContext, entityRepository, loggerFactory)
     { }
 }
-```
+```
+
+## Routing
+
+By default the library will configure routes for each controller. 
+Based on the [recommendations](http://jsonapi.org/recommendations/)
+outlined in the JSONAPI spec, routes are hyphenated. For example:
+
+```
+/todo-items --> TodoItemsController
+NOT /todoItems
+```
+
+### Namespacing and Versioning URLs
+
+You can add a namespace to the URL by specifying it in `ConfigureServices`:
+
+```
+services.AddJsonApi<AppDbContext>(
+    opt => opt.Namespace = "api/v1");
+```

src/JsonApiDotNetCore/Configuration/JsonApiOptions.cs

@@ -0,0 +1,7 @@
+namespace JsonApiDotNetCore.Configuration
+{
+    public class JsonApiOptions
+    {
+        public string Namespace { get; set; }
+    }
+}

src/JsonApiDotNetCore/Extensions/IApplicationBuilderExtensions.cs

@@ -1,35 +1,13 @@
-using System;
-using JsonApiDotNetCore.Internal;
 using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Mvc.Internal;
-using Microsoft.AspNetCore.Routing;
-using Microsoft.Extensions.DependencyInjection;
 
 namespace JsonApiDotNetCore.Routing
 {
     public static class IApplicationBuilderExtensions
     {
         public static IApplicationBuilder UseJsonApi(this IApplicationBuilder app)
         {
-            if (app == null)
-                throw new ArgumentNullException(nameof(app));
-
-            // Verify if AddMvc was done before calling UseMvc
-            // We use the MvcMarkerService to make sure if all the services were added.
-            if (app.ApplicationServices.GetService(typeof(MvcMarkerService)) == null)
-                throw new InvalidOperationException();
-
-            var middlewarePipelineBuilder = app.ApplicationServices.GetRequiredService<MiddlewareFilterBuilder>();
-            middlewarePipelineBuilder.ApplicationBuilder = app.New();
-
-            var routes = new RouteBuilder(app)
-            {
-                DefaultHandler = app.ApplicationServices.GetRequiredService<JsonApiRouteHandler>(),
-            };
-
-            routes.Routes.Insert(0, AttributeRouting.CreateAttributeMegaRoute(app.ApplicationServices));
-
-            return app.UseRouter(routes.Build());
+            app.UseMvc();
+            return app;
         }
     }
 }

src/JsonApiDotNetCore/Extensions/ServiceProviderExtensions.cs

@@ -1,3 +1,5 @@
+using System;
+using JsonApiDotNetCore.Configuration;
 using JsonApiDotNetCore.Data;
 using JsonApiDotNetCore.Formatters;
 using JsonApiDotNetCore.Internal;
@@ -13,10 +15,24 @@ public static class ServiceProviderExtensions
     {
         public static void AddJsonApi<TContext>(this IServiceCollection services) 
             where TContext : DbContext
+        {
+            _addInternals<TContext>(services, new JsonApiOptions());
+        }
+
+        public static void AddJsonApi<TContext>(this IServiceCollection services, Action<JsonApiOptions> options) 
+            where TContext : DbContext
+        {
+            var config = new JsonApiOptions();
+            options(config);
+            _addInternals<TContext>(services, config);
+        }
+
+        private static void _addInternals<TContext>(IServiceCollection services, JsonApiOptions jsonApiOptions)
+            where TContext : DbContext
         {
             services.AddJsonApiInternals<TContext>();
             services.AddMvc()
-                .AddMvcOptions(options => options.SerializeAsJsonApi());
+                .AddMvcOptions(opt => opt.SerializeAsJsonApi(jsonApiOptions));
         }
 
         public static void AddJsonApiInternals<TContext>(this IServiceCollection services) 
@@ -37,11 +53,13 @@ public static void AddJsonApiInternals<TContext>(this IServiceCollection service
             services.AddScoped<JsonApiRouteHandler>();
         }
 
-        public static void SerializeAsJsonApi(this MvcOptions options)
+        public static void SerializeAsJsonApi(this MvcOptions options, JsonApiOptions jsonApiOptions)
         {
             options.InputFormatters.Insert(0, new JsonApiInputFormatter());
 
             options.OutputFormatters.Insert(0, new JsonApiOutputFormatter());
+
+            options.Conventions.Insert(0, new DasherizedRoutingConvention(jsonApiOptions.Namespace));
         }
     }
 }

src/JsonApiDotNetCore/Internal/DasherizedRoutingConvention.cs

@@ -0,0 +1,28 @@
+// REF: https://github.com/aspnet/Entropy/blob/dev/samples/Mvc.CustomRoutingConvention/NameSpaceRoutingConvention.cs
+// REF: https://github.com/aspnet/Mvc/issues/5691
+using JsonApiDotNetCore.Extensions;
+using Microsoft.AspNetCore.Mvc.ApplicationModels;
+
+namespace JsonApiDotNetCore.Internal
+{
+    public class DasherizedRoutingConvention : IApplicationModelConvention
+    {
+        private string _namespace;
+        public DasherizedRoutingConvention(string nspace)
+        {
+            _namespace = nspace;
+        }
+        
+        public void Apply(ApplicationModel application)
+        {
+            foreach (var controller in application.Controllers)
+            {
+                var template = $"{_namespace}/{controller.ControllerName.Dasherize()}";
+                controller.Selectors[0].AttributeRouteModel = new AttributeRouteModel()
+                {
+                    Template = template
+                };
+            }
+        }
+    }
+}

src/JsonApiDotNetCoreExample/Controllers/PeopleController.cs

@@ -2,12 +2,10 @@
 using JsonApiDotNetCore.Data;
 using JsonApiDotNetCore.Services;
 using JsonApiDotNetCoreExample.Models;
-using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    [Route("api/[controller]")]
     public class PeopleController : JsonApiController<Person>
     {
         public PeopleController(

src/JsonApiDotNetCoreExample/Controllers/TodoItemsController.cs

@@ -2,12 +2,10 @@
 using JsonApiDotNetCore.Data;
 using JsonApiDotNetCore.Services;
 using JsonApiDotNetCoreExample.Models;
-using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 
 namespace JsonApiDotNetCoreExample.Controllers
 {
-    [Route("api/[controller]")]
     public class TodoItemsController : JsonApiController<TodoItem>
     {
         public TodoItemsController(

src/JsonApiDotNetCoreExample/Program.cs

@@ -1,8 +1,4 @@
-using System;
-using System.Collections.Generic;
 using System.IO;
-using System.Linq;
-using System.Threading.Tasks;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.Extensions.Configuration;

src/JsonApiDotNetCoreExample/Startup.cs

@@ -31,7 +31,7 @@ public void ConfigureServices(IServiceCollection services)
                 options.UseNpgsql(_getDbConnectionString());
             }, ServiceLifetime.Transient);
 
-            services.AddJsonApi<AppDbContext>();
+            services.AddJsonApi<AppDbContext>(opt => opt.Namespace = "api/v1");
         }
 
         public void Configure(