document options

Author: jaredcnance

couscous.yml

@@ -110,4 +110,7 @@ menu:
                     relativeUrl: entityrepositories.html
                 middleware:
                     text: Middleware
-                    relativeUrl: middleware.html
+                    relativeUrl: middleware.html
+                customqueryformat:
+                    text: Custom Query Formats
+                    relativeUrl: customqueryformat.html

docs/CustomQueryFormat.md

@@ -0,0 +1,13 @@
+---
+currentMenu: customqueryformat
+---
+
+# Custom Query Formats
+
+For information on the default query parameter formats, see the documentation for each query method.
+
+In order to customize the query formats, you need to implement the `IQueryParser` interface and inject it like so:
+
+```csharp
+services.AddScoped<IQueryParser, FooQueryParser>();
+```

docs/Options.md

@@ -80,4 +80,32 @@ Accept: application/vnd.api+json
         }
     }
 }
+```
+
+## Custom Query Parameters
+
+If you would like to use custom query params (parameters not reserved by the json:api specification), you can set `AllowCustomQueryParameters = true`. The default behavior is to return an `HTTP 400 Bad Request` for unknown query parameters.
+
+```csharp
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.AllowCustomQueryParameters = true);
+    // ...
+}
+```
+
+## Custom Serializer Settings
+
+We use Json.Net for all serialization needs. If you want to change the default serializer settings, you can:
+
+```csharp
+public IServiceProvider ConfigureServices(IServiceCollection services) {
+    services.AddJsonApi<AppDbContext>(
+        opt => opt.SerializerSettings = new JsonSerializerSettings()
+        {
+            NullValueHandling = NullValueHandling.Ignore,
+            ContractResolver = new DasherizedResolver()
+        });
+    // ...
+}
 ```

docs/QueryingData.md

@@ -1,8 +1,5 @@
-using System;
 using System.Linq;
-using System.Reflection;
 using System.Threading.Tasks;
-using JsonApiDotNetCore.Controllers;
 using JsonApiDotNetCore.Internal;
 using Microsoft.AspNetCore.Mvc.Filters;
 
@@ -17,15 +14,15 @@ public override async Task OnActionExecutionAsync(
             ActionExecutionDelegate next)
         {
             var method = context.HttpContext.Request.Method;
-            
-            if(CanExecuteAction(method) == false)
+
+            if (CanExecuteAction(method) == false)
                 throw new JsonApiException(405, $"This resource does not support {method} requests.");
 
             await next();
         }
 
         private bool CanExecuteAction(string requestMethod)
-        {            
+        {
             return Methods.Contains(requestMethod) == false;
         }
     }