Awesome Open Source
Awesome Open Source


A framework for building JSON:API compliant REST APIs using .NET Core and Entity Framework Core. Includes support for Atomic Operations.

Build Coverage NuGet Chat FIRST-TIMERS

The ultimate goal of this library is to eliminate as much boilerplate as possible by offering out-of-the-box features such as sorting, filtering and pagination. You just need to focus on defining the resources and implementing your custom business logic. This library has been designed around dependency injection, making extensibility incredibly easy.

Getting Started

These are some steps you can take to help you understand what this project is and how you can use it:

Related Projects


See the examples directory for up-to-date sample applications. There is also a Todo List App that includes a JsonApiDotNetCore API and an EmberJs client.

Installation and Usage

See our documentation for detailed usage.


public class Article : Identifiable
    public string Name { get; set; }


public class ArticlesController : JsonApiController<Article>
    public ArticlesController(IJsonApiOptions options, ILoggerFactory loggerFactory,
        IResourceService<Article> resourceService,)
        : base(options, loggerFactory, resourceService)


public class Startup
    public IServiceProvider ConfigureServices(IServiceCollection services)

    public void Configure(IApplicationBuilder app)
        app.UseEndpoints(endpoints => endpoints.MapControllers());


The following chart should help you pick the best version, based on your environment. See also our versioning policy.

.NET version EF Core version JsonApiDotNetCore version
Core 2.x 2.x 3.x
Core 3.1 3.1 4.x
Core 3.1 5 4.x
5 5 4.x or 5.x
6 6 5.x


Have a question, found a bug or want to submit code changes? See our contributing guidelines.

Trying out the latest build

After each commit to the master branch, a new prerelease NuGet package is automatically published to AppVeyor at To try it out, follow the next steps:

  • In Visual Studio: Tools, NuGet Package Manager, Package Manager Settings, Package Sources
  • Open the NuGet package manager console (Tools, NuGet Package Manager, Package Manager Console)
    • Select AppVeyor JADNC as package source
    • Run command: Install-Package JonApiDotNetCore -pre


To build the code from this repository locally, run:

dotnet build

Running tests locally requires access to a PostgreSQL database. If you have docker installed, this can be propped up via:

pwsh run-docker-postgres.ps1

And then to run the tests:

dotnet test

Alternatively, to build and validate the code, run all tests, generate code coverage and produce the NuGet package:

pwsh Build.ps1

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
C Sharp (276,229
Dotnet Core (4,299
Rest (4,083
Asp Net Core (3,654
Mvc (2,403
Crud (1,786
Json Api (1,191
Webapi (1,054
Emberjs (459
Related Projects