DvBCrud.API 1.1.0

DvBCrud.API

Library for rapidly developing CRUD API-endpoints for database entities.

Table of Contents

• How it works
• Getting started
  • 1. Create entity, model, mapper and repository
  • 2. Create a CRUDController
  • 3. Use it
• Restricting actions
  • Read-only endpoint
  • Non-deletable endpoint
  • Hide restricted actions in Swagger Docs
• API Example

How it works

DvBCrud.EFCore.API is a complement to DvBCrud.EFCore for streamlining development of CRUD APIs.

The CRUDController comes in two flavors: the synchronous CRUDController and the asynchronous AsyncCRUDController. Depending on your needs and use-case, you may use one or both of them.

Both controller types implement the following actions:

• CREATE: POST /customer/
• READ: GET /customer/{id}
• LIST: GET /customer/
• UPDATE: PUT /customer/{id}
• DELETE: DELETE /customer/{id}

Getting started

1. Create entity, model, mapper and repository

Follow this guide to create your entities and your repository.

2. Create a CRUDController

Create the CRUDController for the entity and its repository

AnyController.cs

public class AnyController : CrudController<long, AnyModel, AnyRepository>
{
    public AnyController(AnyRepository repository) : base(repository)
    {
    }
}

3. Use it

If you're using services.AddControllers() in Startup.cs, you're good to go. The controller is now up and running on your application.

Restricting actions

You can restrict which actions are permitted by adding the CrudActionAttribute on the class. When a forbidden action is requested, the endpoint will return a 403 FORBIDDEN response.

If the attribute is not defined, the controller will default to allow all actions.

Here are some examples:

Read-only endpoint

AnyController.cs

[AllowedActions(CRUDAction.Read)]
public class AnyController : CrudController<long, AnyModel, AnyRepository>
{
    public AnyController(AnyRepository repository) : base(repository)
    {
    }
}

Non-deletable endpoint

AnyController.cs

[AllowedActions(CRUDAction.Create | CRUDAction.Read | CRUDAction.Update)]
public class AnyController : CrudController<long, AnyModel, AnyRepository>
{
    public AnyController(AnyRepository repository) : base(repository)
    {
    }
}

Hide restricted actions in Swagger Docs

To hide the restricted actions in Swagger UI, you need to add the SwaggerDocsFilter when declaring Swagger in Program.cs like so:

...
services.AddSwaggerGen(c => {
    c.DocumentFilter<SwaggerDocsFilter>();
}
...

API Example

You can find a fully-implemented working API example in the DvBCrud.API.Tests.Web project.