JsonApiDotNetCore
-A framework for building JSON:API compliant REST APIs using .NET Core and Entity Framework Core. Includes support for Atomic Operations.
++ A framework for building JSON:API compliant REST APIs using .NET Core and Entity Framework Core. + Includes support for Atomic Operations. +
Read more Getting started Contribute on GitHub @@ -43,12 +46,13 @@A framework for building JSON
Objectives
- The goal of this library is to simplify the development of APIs that leverage the full range of features provided by the JSON:API specification.
+ The goal of this library is to simplify the development of APIs that leverage the full range of features
+ provided by the JSON:API specification.
You just need to focus on defining the resources and implementing your custom business logic.
-
+
Eliminate boilerplate
We strive to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination.
@@ -69,28 +73,28 @@ Features
The following features are supported, from HTTP all the way down to the database
-
+
Filtering
Perform compound filtering using the filter query string parameter
-
+
-
+
Sorting
Order resources on one or multiple attributes using the sort query string parameter
-
+
Pagination
Leverage the benefits of paginated resources with the page query string parameter
-
+
Sparse fieldset selection
@@ -99,30 +103,30 @@ Sparse fieldset selection
-
+
Relationship inclusion
Side-load related resources of nested relationships using the include query string parameter
-
+
-
+
Security
- Configure permissions, such as view/create/change/sort/filter of attributes and relationships
+ Configure permissions, such as viewing, creating, modifying, sorting and filtering of attributes and relationships
-
+
-
+
Validation
- Validate incoming requests using built-in ASP.NET Core ModelState validation, which works seamlessly with partial updates
+ Validate incoming requests using built-in ASP.NET Model Validation, which works seamlessly with partial updates
-
+
-
+
Customizable
Use various extensibility points to intercept and run custom code, besides just model annotations
@@ -139,7 +143,7 @@ Example usage
-
+
Resource
#nullable enable
@@ -179,16 +183,16 @@ Resource
-
+
Request
GET /articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields[articles]=title,summary&include=author HTTP/1.1
-
+
-
+
Response
{
@@ -259,15 +263,15 @@ Response
Sponsors
-
-
+
+
-
-
+
+
Objectives
- The goal of this library is to simplify the development of APIs that leverage the full range of features provided by the JSON:API specification. + The goal of this library is to simplify the development of APIs that leverage the full range of features + provided by the JSON:API specification. You just need to focus on defining the resources and implementing your custom business logic.
Eliminate boilerplate
We strive to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination.
Features
The following features are supported, from HTTP all the way down to the database
Filtering
Perform compound filtering using the filter query string parameter
Sorting
Order resources on one or multiple attributes using the sort query string parameter
Pagination
Leverage the benefits of paginated resources with the page query string parameter
Sparse fieldset selection
@@ -99,30 +103,30 @@Sparse fieldset selection
Relationship inclusion
Side-load related resources of nested relationships using the include query string parameter
Security
-Configure permissions, such as view/create/change/sort/filter of attributes and relationships
+Configure permissions, such as viewing, creating, modifying, sorting and filtering of attributes and relationships
Validation
-Validate incoming requests using built-in ASP.NET Core ModelState validation, which works seamlessly with partial updates
Validate incoming requests using built-in ASP.NET Model Validation, which works seamlessly with partial updates
Customizable
Use various extensibility points to intercept and run custom code, besides just model annotations
Example usage
Resource
#nullable enable
@@ -179,16 +183,16 @@ Resource
-
+
Request
GET /articles?filter=contains(summary,'web')&sort=-lastModifiedAt&fields[articles]=title,summary&include=author HTTP/1.1
-
+
-
+
Response
{
@@ -259,15 +263,15 @@ Response
Sponsors
-
-
+
+
-
-
+
+