DotNetBrightener.WebApi.GenericCRUD 2024.0.14.6-preview-1911302

Centralized CRUD WebAPI in ASP.NET Core Applications

© 2024 DotNet Brightener. admin@dotnetbrightener.com

Instruction

Most applications rely on CRUD operations. This library provides core CRUD functionalities, exposing them as WebAPI controllers, utilizing DotNetBrightener.DataAccess.Abstractions library, which facilitates the database access layer performing the CRUD operations.

Implement in your project

Let's say in your project, you have the following class defined:

public class ProductDocument : BaseEntityWithAuditInfo
{
    [MaxLength(255)]
    public string FileName { get; set; }
 
    [MaxLength(1024)]
    public string Description { get; set; }
 
    [MaxLength(2048)]
    public string FileUrl { get; set; }
 
    public Guid? FileGuid { get; set; }
 
    public int? DisplayOrder { get; set; }
 
    [DataType(DataType.Currency)]
    public decimal? Price { get; set; }
}

You will need to create a DataService interface and implementation class like the following:

public partial interface IProductDocumentDataService : IBaseDataService<ProductDocument> { }
 
public partial class ProductDocumentDataService : BaseDataService<ProductDocument>, IProductDocumentDataService {
    
    public ProductDocumentDataService(IRepository repository)
        : base(repository)
    {
    }
}

The IBaseDataService<> interface and BaseDataService<> base class are defined in DotNetBrightener.DataAccess.Abstractions library. They provided CRUD operation already so you will not need to write CRUD operation yourself. The implementation is highly customizable, so you can change the logic based on your application's need.

You can then create a controller as followed:

[ApiController]
[Route("api/[controller]")]
public partial class ProductDocumentController : BaseCRUDController<ProductDocument>
{
    public ProductDocumentController(
            IProductDocumentDataService dataService,
            IHttpContextAccessor httpContextAccessor)
        : base(dataService, httpContextAccessor)
    {
    }
}

In Startup.cs or Program.cs, register your DataService interface and implementation class to the ServiceCollection as followed:

builder.Services.AddScoped<IProductDocumentDataService, ProductDocumentDataService>();

If you use CORS, you will need to add the following to the ConfigureServices method in Startup.cs:

    services.AddCors(options =>
    {
        options.AddPolicy("CorsPolicy",
                            builder =>
                            {
                                // other configurations for your CORS policy builder

                                // builder.AllowAnyMethod()
                                //        .AllowAnyHeader();

                                  
                                // This is required for the headers that returned from the paged list API to be exposed to the consumers
                                builder.AddPagedDataSetExposedHeaders();
                            });
    });

Now your API is available. Check out the next section for the available APIs and what to expect.

Available CRUD APIs

The following API for CRUD will be available when you implement the CRUD controllers.

GET /api/[entity]

• Retrieve list of records of the entity type, and satisfies the filter, if provided

This API accepts the following query string parameters:

column_name is case-sensitive. You will need to obtain the correct name of the column from the response body.

There is no OR operator supported at the moment, because the nature of HTTP query strings combined by & operator. Therefore, only AND operator can be supported.

You can use custom queries for the {column_name} parameter with different operators. Here's a table explaining how to use them:

The follow operators are supported in most of all data types, string, int, long, float, double

The following operators are supported for string data type.

The following operators are supported for int, float, double, decimal, datetime and datetimeoffset data type.

The response of the API also has the headers as followed that help you identify the total items available, the result count, requested page size and requested page index. See the below table for details.

GET /api/[entity]/[id]

• Get the record of the entity type by id

This API accepts the following query string parameters

POST /api/[entity]

• Create a new record of the entity type

PUT /api/[entity]/{id}

• Update entity by id

The body of the request can be part of the entity. Only the provided fields in the body will be updated to the entity specified by the id

DELETE /api/[entity]/{id}

• Delete entity by id

PUT /api/[entity]/{id}/undelete

• Restore the deleted record of the entity by id