eQuantic.Core.Api.Crud.Client 1.7.16

There is a newer version of this package available.
See the version list below for details.
dotnet add package eQuantic.Core.Api.Crud.Client --version 1.7.16                
NuGet\Install-Package eQuantic.Core.Api.Crud.Client -Version 1.7.16                
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="eQuantic.Core.Api.Crud.Client" Version="1.7.16" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add eQuantic.Core.Api.Crud.Client --version 1.7.16                
#r "nuget: eQuantic.Core.Api.Crud.Client, 1.7.16"                
#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 eQuantic.Core.Api.Crud.Client as a Cake Addin
#addin nuget:?package=eQuantic.Core.Api.Crud.Client&version=1.7.16

// Install eQuantic.Core.Api.Crud.Client as a Cake Tool
#tool nuget:?package=eQuantic.Core.Api.Crud.Client&version=1.7.16                

eQuantic.Core.Api.Crud Library

The eQuantic Core API CRUD provides all the implementation needed to publish CRUD APIs.

To install eQuantic.Core.Api.Crud, run the following command in the Package Manager Console

Install-Package eQuantic.Core.Api.Crud

Example of implementation

The data entities

[Table("orders")]
public class OrderData : EntityDataBase
{
    [Key]
    public string Id { get; set; } = string.Empty;
    public DateTime Date { get; set; }
    
    public virtual ICollection<OrderItemData> Items { get; set; } = new HashSet<OrderItemData>();
}

[Table("orderItems")]
public class OrderItemData : EntityDataBase, IWithReferenceId<OrderItemData, int>
{
    [Key]
    public int Id { get; set; }
    public int OrderId { get; set; }
    
    [ForeignKey(nameof(OrderId))]
    public virtual OrderData? Order { get; set; }
    
    [Required]
    [MaxLength(200)]
    public string Name { get; set; } = string.Empty;
}

The models

public class Order
{
    public string Id { get; set; } = string.Empty;
    public DateTime Date { get; set; }
}

public class OrderItem
{
    public int Id { get; set; }
    public int OrderId { get; set; }
    public string Name { get; set; } = string.Empty;
}

The request models

public class OrderRequest
{
    public DateTime? Date { get; set; }
}

public class OrderItemRequest
{
    public string? Name { get; set; }
}

The mappers

public class OrderMapper : IMapper<OrderData, Order>, IMapper<OrderRequest, OrderData>
{
    public Order? Map(OrderData? source)
    {
        return Map(source, new Order());
    }

    public Order? Map(OrderData? source, Order? destination)
    {
        if (source == null)
        {
            return null;
        }

        if (destination == null)
        {
            return Map(source);
        }

        destination.Id = source.Id;
        destination.Date = source.Date;

        return destination;
    }

    public OrderData? Map(OrderRequest? source)
    {
        return Map(source, new OrderData());
    }

    public OrderData? Map(OrderRequest? source, OrderData? destination)
    {
        if (source == null)
        {
            return null;
        }

        if (destination == null)
        {
            return Map(source);
        }
        
        destination.Date = source.Date ?? DateTime.UtcNow;

        return destination;
    }
}

The services

public interface IOrderService : ICrudService<Order, OrderRequest>
{
    
}

[MapCrudEndpoints]
public class OrderService : CrudServiceBase<Order, OrderRequest, OrderData, UserData>, IOrderService
{
    public OrderService(IQueryableUnitOfWork unitOfWork, IMapperFactory mapperFactory) : base(unitOfWork, mapperFactory)
    {
    }
}

The Program.cs

var builder = WebApplication.CreateBuilder(args);
var assembly = typeof(Program).Assembly;

builder.Services.AddDbContext<ExampleDbContext>(opt =>
    opt.UseInMemoryDatabase("ExampleDb"));
        
builder.Services.AddQueryableRepositories<ExampleUnitOfWork>(opt =>
{
    opt.FromAssembly(assembly)
        .AddLifetime(ServiceLifetime.Scoped);
});

builder.Services
    .AddMappers(opt => opt.FromAssembly(assembly))
    .AddTransient<IExampleService, ExampleService>()
    .AddControllers()
    .AddJsonOptions(options =>
    {
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
        options.JsonSerializerOptions.PropertyNamingPolicy = JsonNamingPolicy.CamelCase;
    })
    .AddFilterModelBinder()
    .AddSortModelBinder();

builder.Services
    .AddEndpointsApiExplorer()
    .AddApiDocumentation(opt => opt.WithTitle("Example API"));

var app = builder.Build();

if (app.Environment.IsDevelopment())
{
    app.UseApiDocumentation();
}

app.UseHttpsRedirection();
app.UseRouting();
app.MapControllers();
app.MapCrud<Order, OrderRequest, IOrderService>();

app.Run();

or

...
app.MapAllCrud(opt => opt.FromAssembly(assembly));
app.Run();
Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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)
Included target framework(s) (in package)
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
1.7.18 84 10/11/2024
1.7.17 82 10/4/2024
1.7.16 75 10/4/2024
1.7.15 81 10/3/2024
1.7.14 97 9/4/2024
1.7.13 77 9/2/2024
1.7.12 97 9/1/2024
1.7.11 117 8/25/2024
1.7.10 114 8/22/2024
1.7.9 61 8/2/2024
1.7.8 73 7/29/2024
1.7.7 75 7/28/2024
1.7.6 77 7/27/2024
1.7.5 73 7/23/2024
1.7.4 84 7/22/2024
1.7.3 97 6/26/2024
1.7.2 95 6/26/2024
1.7.1 105 5/31/2024
1.7.0 108 5/29/2024
1.6.26 97 5/18/2024
1.6.25 109 5/15/2024
1.6.24 89 5/14/2024
1.6.23 121 5/4/2024
1.6.22 105 5/4/2024
1.6.21 123 4/28/2024
1.6.20 109 4/21/2024
1.6.19 107 4/20/2024
1.6.18 108 4/20/2024
1.6.17 93 4/11/2024
1.6.16 90 4/11/2024
1.6.15 112 4/9/2024
1.6.14 110 4/4/2024
1.6.13 105 4/2/2024
1.6.12 106 3/21/2024
1.6.11 104 3/21/2024
1.6.10 113 3/18/2024
1.6.9 122 3/10/2024
1.6.8 126 2/18/2024
1.6.7 113 2/17/2024
1.6.6 128 2/14/2024
1.6.5 121 2/13/2024
1.6.4 120 2/12/2024
1.6.3 110 2/10/2024
1.6.2 108 2/10/2024
1.6.1 127 1/22/2024
1.6.0 163 12/21/2023
1.5.2 122 12/10/2023
1.5.1 136 12/5/2023
1.5.0 127 12/5/2023
1.4.0 120 12/3/2023
1.3.3 140 11/18/2023
1.3.2 95 11/18/2023
1.3.1 159 11/15/2023
1.3.0 73 11/15/2023
1.2.3 91 11/2/2023
1.2.2 84 11/2/2023
1.2.1 161 10/21/2023
1.2.0 86 10/21/2023

Conventions for API CRUD Client Layer