JSONAPI Framework for ASP.Net Core
jaredcnance Merge pull request #403 from btecu/services
Remove `DocumentData`, instead use `ResourceObject`
Latest commit 491a6cb Sep 11, 2018

README.md

JSON API .Net Core

Build status Travis NuGet Join the chat at https://gitter.im/json-api-dotnet-core/Lobby FIRST-TIMERS

A framework for building json:api compliant web APIs. 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

Examples

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

Installation And Usage

See the documentation for detailed usage.

Models

public class Article : Identifiable
{ 
    [Attr("name")]
    public string Name { get; set; }
}

Controllers

public class ArticlesController : JsonApiController<Article>
{
    public ArticlesController(
        IJsonApiContext jsonApiContext,
        IResourceService<Article> resourceService) 
    : base(jsonApiContext, resourceService) { }
}

Middleware

public class Startup 
{
    public IServiceProvider ConfigureServices(IServiceCollection services) {
        services.AddJsonApi<AppDbContext>();
        // ...
    }

    public void Configure(IApplicationBuilder app)  {
        app.UseJsonApi()
        // ...
    }
}

Development

Restore all nuget packages with:

dotnet restore

Testing

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

docker run --rm --name jsonapi-dotnet-core-testing \
  -e POSTGRES_DB=JsonApiDotNetCoreExample \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=postgres \
  -p 5432:5432 \
  postgres

And then to run the tests:

dotnet test

Cleaning

Sometimes the compiled files can be dirty / corrupt from other branches / failed builds.

dotnet clean