DotNetBrightener.WebApi.GenericCRUD 2024.0.8

dotnet add package DotNetBrightener.WebApi.GenericCRUD --version 2024.0.8
NuGet\Install-Package DotNetBrightener.WebApi.GenericCRUD -Version 2024.0.8
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DotNetBrightener.WebApi.GenericCRUD" Version="2024.0.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DotNetBrightener.WebApi.GenericCRUD --version 2024.0.8
#r "nuget: DotNetBrightener.WebApi.GenericCRUD, 2024.0.8"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DotNetBrightener.WebApi.GenericCRUD as a Cake Addin
#addin nuget:?package=DotNetBrightener.WebApi.GenericCRUD&version=2024.0.8

// Install DotNetBrightener.WebApi.GenericCRUD as a Cake Tool
#tool nuget:?package=DotNetBrightener.WebApi.GenericCRUD&version=2024.0.8

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:

Parameter Type Description
columns string[], separate by commas The columns / fields of the entity to retrieve
pageSize number The number of records to return in one page, default is 20
pageIndex number The index of the page to return, default is 0
orderBy string The column to sort the result by, in ascending order. If the value starts with a hyphen (-) and followed by the column name, the result is sorted in descending order. This parameter impacts how the data is returned.
{column_name} any The filter expressions to filter the result by the column_name. Eg: createdBy=user* will filter the result to return the records that have CreatedBy value starts with user. Or, summary=contains(value3)&createdDate=<=2023-12-01, will filter the records that have summary value contains value3 in the string, and createdDate is before 01 Dec 2023.<br/><br/>See the tables below for more detail.

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

Operator Symbol Example Usage Description
Equals eq (default) id=eq(100) or id=100 Filters records where the id value matches the one on the right side of the query or in the parentheses.
Not Equals ne id=ne_100 <br /> id=ne(100)<br/> id=!(100) Filters the records where the id value doesn't not equal the value on the right operand or in the parentheses.
In in summary=in(valuea,valueb) Filters the records where the summary is in the values defined in the parentheses.
Not In notin<br /> !in summary=notin(valuea,valueb)<br />summary=!in(valuea,valueb) Filters the records where the summary IS NOT in the values defined in the parentheses.

The following operators are supported for string data type.

Operator Symbol Example Usage Description
Contains contains<br/>like<br/>*keyword* summary=contains(value)<br />summary=like(value)<br />summary=*value* Filters the records where the summary contains the value in the parentheses.
Not Contains notcontains<br/>notlike<br/>!contains<br />!like summary=!contains(value)<br />summary=!like(value) Filters the records where the summary DOES NOT contains the value in the parentheses.
Starts With startsWith<br />sw<br/>keyword* summary=startsWith(value)<br/>summary=sw(value)<br/>summary=value* Filters the records where the summary starts with the value in the parentheses or on the right side of the query.
Not Starts With !startsWith<br />!sw summary=!startsWith(value)<br/>summary=!sw(value) Filters the records where the summary DOES NOT start with the value in the parentheses.
Ends With endsWith<br/>ew<br/>*keyword summary=endsWith(value)<br />summary=ew(value)<br/>summary=*value Filters the records where the summary ends with the value in the parentheses or on the right side of the query.
Not Ends With !endsWith<br/>!ew summary=!endsWith(value)<br />summary=!ew(value) Filters the records where the summary DOES NOT end with the value in the parentheses.

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

Operator Symbol Example Usage Description
Greater Than<br />After (for datetime types) > id=>(10)<br />displayIndex=>(200)<br />expirationDate=>(2023-12-01) -
Greater Than or Equals<br />On or After (for datetime type) >= id=>=(10)<br />displayIndex=>=(200)<br />expirationDate=>=(2023-12-01) -
Less Than<br />Before (for datetime types) < id=<(10)<br />displayIndex=<(200)<br />invoiceDate=<(2023-12-01) -
Less Than or Equals<br />Before or On (for datetime types) <= id=<=(10)<br />displayIndex=<=(200)<br />invoiceDate=<=(2023-12-01) -

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.

Header Description
X-Total-Count The total number of items available based on the filter defined in the request
X-Result-Count The number of items returned in the current page
X-Page-Size The requested page size
X-Page-Index The requested page index

GET /api/[entity]/[id]

  • Get the record of the entity type by id

This API accepts the following query string parameters

Parameter Type Description
columns string[], separate by commas The columns / fields of the entity to retrieve

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
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2024.0.8 126 2/1/2024
2024.0.7 82 1/26/2024
2024.0.6 79 1/25/2024
2024.0.5 72 1/24/2024
2024.0.4 69 1/24/2024
2024.0.3 77 1/22/2024
2024.0.2 147 1/10/2024
2024.0.1 89 1/9/2024
2024.0.1-alpha-3 82 1/9/2024
2024.0.1-alpha-2 80 1/9/2024
2024.0.1-alpha-1 97 1/3/2024
2024.0.0 147 12/26/2023
2023.0.27 94 12/21/2023
2023.0.26 79 12/21/2023
2023.0.25 117 12/11/2023
2023.0.24 95 12/8/2023
2023.0.23 88 12/6/2023
2023.0.21 99 12/4/2023
2023.0.20 141 11/27/2023
2023.0.19 97 11/20/2023
2023.0.18 115 10/25/2023
2023.0.17 163 10/22/2023
2023.0.16 122 10/16/2023
2023.0.16-alpha-1 68 10/16/2023
2023.0.15 118 10/14/2023
2023.0.14 88 10/14/2023
2023.0.13 96 10/14/2023
2023.0.12 100 10/14/2023
2023.0.11 90 10/10/2023
2023.0.10 93 10/9/2023
2023.0.9 120 8/16/2023
2023.0.8 102 8/15/2023
2023.0.8-alpha-2 182 5/31/2023
2023.0.7 112 5/12/2023
2023.0.6 124 5/10/2023
2023.0.5 106 5/7/2023
2023.0.4 135 4/22/2023
2023.0.3 164 4/19/2023
2023.0.2 164 4/6/2023
2023.0.1 183 3/13/2023
2022.11.0 300 11/21/2022
2022.10.2 291 11/9/2022
2022.10.1 309 10/28/2022