Skip to content


Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?


Failed to load latest commit information.
Latest commit message
Commit time
September 21, 2023 12:12
March 20, 2017 14:20
April 6, 2022 12:27
November 2, 2017 15:09


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:


Official documentation


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.


#nullable enable

public class Article : Identifiable<int>
    public string Name { get; set; } = null!;


// Program.cs


// ...



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

JsonApiDotNetCore Status .NET Entity Framework Core
3.x Stable Core 2.x 2.x
4.x Stable Core 3.1 3.1
Core 3.1 5
5 5
6 5
5.0.0-5.0.2 Stable 6 6
5.0.3+ Stable 6 6
6 7
7 7


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 pre-release NuGet package is automatically published to GitHub Packages. To try it out, follow the steps below:

  1. Create a Personal Access Token (classic) with at least read:packages scope.

  2. Add our package source to your local user-specific nuget.config file by running:

    dotnet nuget add source --name github-json-api --username YOUR-GITHUB-USERNAME --password YOUR-PAT-CLASSIC

    In the command above:

    • Replace YOUR-GITHUB-USERNAME with the username you use to login your GitHub account.
    • Replace YOUR-PAT-CLASSIC with the token your created above.

    ⚠️ If the above command doesn't give you access in the next step, remove the package source by running:

    dotnet nuget remove source github-json-api

    and retry with the --store-password-in-clear-text switch added.

  3. Restart your IDE, open your project, and browse the list of packages from the github-json-api feed (make sure pre-release packages are included).


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, run all tests, generate code coverage and NuGet packages:

pwsh Build.ps1


JetBrains Logo   Araxis Logo