Rystem.RepositoryFramework.Api.Server 6.2.0

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

// Install Rystem.RepositoryFramework.Api.Server as a Cake Tool
#tool nuget:?package=Rystem.RepositoryFramework.Api.Server&version=6.2.0                

What is Rystem?

Api auto-generated

In your web application you have only to add one row after service build.

 services.AddApiFromRepositoryFramework()
    .WithDescriptiveName("Repository Api")
    .WithPath(Path)
    .WithSwagger()
    .WithVersion(Version)
    .WithDocumentation()
    .WithDefaultCors("http://example.com");

var app = builder.Build();
app.UseApiFromRepositoryFramework()
   .WithNoAuthorization();

public static ApiAuthorizationBuilder UseApiFromRepositoryFramework<TEndpointRouteBuilder>(
    this TEndpointRouteBuilder app,
    string startingPath = "api")
    where TEndpointRouteBuilder : IEndpointRouteBuilder

You may add api for each service by

public static ApiAuthorizationBuilder UseApiForRepository<T>(this IEndpointRouteBuilder app,
    string startingPath = "api")

Startup example

In the example below you may find the setup of three populated repositories, two of them are of the same kind (SuperUser). The SuperiorUser will be added to the app but will be not exposed as Api cause the SetNotExposable() method. Futhermore, we are adding a configuration for AAD to implement authentication on api.

var builder = WebApplication.CreateBuilder(args);
builder.Services
.AddRepository<SuperUser, string>(settins =>
{
    settins.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(120, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com");
    });
    settins.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(2, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com");
    }, "inmemory");
});

builder.Services.AddRepository<SuperiorUser, string>(settings =>
{
    settings.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(120, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com")
            .WithPattern(x => x.Value!.Port, @"[1-9]{3,4}");
    });
    settings.SetNotExposable();
});
    
builder.Services.AddApiFromRepositoryFramework()
    .WithDescriptiveName("Repository Api")
    .WithPath(Path)
    .WithSwagger()
    .WithVersion(Version)
    .WithDocumentation()
    .WithDefaultCors("http://example.com");  

var app = builder.Build();
await app.Services.WarmUpAsync();

app.UseHttpsRedirection();
app.UseApiFromRepositoryFramework()
    .WithDefaultAuthorization();
app.Run();

No Authorization flow - default

var builder = WebApplication.CreateBuilder(args);
builder.Services
.AddRepository<SuperUser, string>(settins =>
{
    settins.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(120, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com");
    });
    settins.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(2, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com");
    }, "inmemory");
});

builder.Services.AddRepository<SuperiorUser, string>(settings =>
{
    settings.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(120, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com")
            .WithPattern(x => x.Value!.Port, @"[1-9]{3,4}");
    });
    settings.SetNotExposable();
});
builder.Services.AddApiFromRepositoryFramework()
    .WithDescriptiveName("Repository Api")
    .WithPath(Path)
    .WithSwagger()
    .WithVersion(Version)
    .WithDocumentation()
    .WithDefaultCors("http://example.com");    

var app = builder.Build();
await app.Services.WarmUpAsync();
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
app.UseHttpsRedirection();
app.UseApiFromRepositoryFramework()
    .WithNoAuthorization();
app.Run();

Authorization flow - custom policies

You may configure the scoper for each method of your repository and for each repository, as you wish.

var builder = WebApplication.CreateBuilder(args);
builder.Services
.AddRepository<SuperUser, string>(settins =>
{
    settins.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(120, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com");
    });
    settins.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(2, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com");
    }, "inmemory");
});

builder.Services.AddRepository<SuperiorUser, string>(settings =>
{
    settings.WithInMemory(builder =>
    {
        builder
            .PopulateWithRandomData(120, 5)
            .WithPattern(x => x.Value!.Email, @"[a-z]{5,10}@gmail\.com")
            .WithPattern(x => x.Value!.Port, @"[1-9]{3,4}");
    });
    settings.SetNotExposable();
});

builder.Services.AddAuthorization(
    options =>
    {
        options.AddPolicy("NormalUser", x =>
        {
            x.RequireClaim(ClaimTypes.Name);
        });
        options.AddPolicy("SuperAdmin", x =>
        {
            x.RequireRole("SuperAdmin");
        });
    });

builder.Services.AddApiFromRepositoryFramework()
    .WithDescriptiveName("Repository Api")
    .WithPath(Path)
    .WithSwagger()
    .WithVersion(Version)
    .WithDocumentation()
    .WithDefaultCors("http://example.com");     

var app = builder.Build();
await app.Services.WarmUpAsync();
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
app.UseHttpsRedirection();

app.UseEndpoints(endpoints =>
{
    endpoints.MapHealthChecks("/healthz");
    endpoints.UseApiFromRepository<SuperUser>()
        .SetPolicyForCommand()
        .With("SuperAdmin")
        .Build();
    endpoints.UseApiFromRepositoryFramework()
        .SetPolicyForAll()
        .With("NormalUser")
        .And()
        .SetPolicy(RepositoryMethods.Insert)
        .With("SuperAdmin")
        .And()
        .SetPolicy(RepositoryMethods.Update)
        .With("SuperAdmin")
        .Build();
    endpoints
        .MapControllers();
});
app.Run();

In this example, I'm configuring a policy named "NormalUser" for all methods and all repositories, and a policy named "SuperAdmin" for the methods Insert and Update for all repositories and for the command (Insert, Updated and Delete) of SuperUser repository. You can customize it repository for repository, using UseApiFromRepository<T>() method.

Sample of filter usage when you use the api directly

All the requests are basic requests, the strangest request is only the query and you must use the Linq query. You may find some examples down below:

ƒ => (((ƒ.X == "dasda") AndAlso ƒ.X.Contains("dasda")) AndAlso ((ƒ.E == Guid.Parse("bf46510b-b7e6-4ba2-88da-cef208aa81f2")) Or (ƒ.Id == 32)))
ƒ => ((((ƒ.X == "dasda") AndAlso ƒ.Sol) AndAlso ƒ.X.Contains("dasda")) AndAlso ((ƒ.E == Guid.Parse("bf46510b-b7e6-4ba2-88da-cef208aa81f2")) Or (ƒ.Id == 32)))
ƒ => (((((ƒ.X == "dasda") AndAlso ƒ.Sol) AndAlso ƒ.X.Contains("dasda")) AndAlso ((ƒ.E == Guid.Parse("bf46510b-b7e6-4ba2-88da-cef208aa81f2")) Or (ƒ.Id == 32))) AndAlso ((ƒ.Type == 1) OrElse (ƒ.Type == 2)))
ƒ => (ƒ.Type == 2)
ƒ => (((((ƒ.X == "dasda") AndAlso ƒ.Sol) AndAlso (ƒ.X.Contains("dasda") OrElse ƒ.Sol.Equals(True))) AndAlso ((ƒ.E == Guid.Parse("bf46510b-b7e6-4ba2-88da-cef208aa81f2")) Or (ƒ.Id == 32))) AndAlso ((ƒ.Type == 1) OrElse (ƒ.Type == 2)))
ƒ => ((((((ƒ.X == "dasda") AndAlso ƒ.Samules.Any(x => (x == "ccccde"))) AndAlso ƒ.Sol) AndAlso (ƒ.X.Contains("dasda") OrElse ƒ.Sol.Equals(True))) AndAlso ((ƒ.E == Guid.Parse("bf46510b-b7e6-4ba2-88da-cef208aa81f2")) Or (ƒ.Id == 32))) AndAlso ((ƒ.Type == 1) OrElse (ƒ.Type == 2)))
ƒ => (ƒ.ExpirationTime > Convert.ToDateTime("7/6/2022 9:48:56 AM"))
ƒ => (ƒ.TimeSpan > new TimeSpan(1000 as long))
ƒ => Not(ƒ.Inside.Inside.A.Equals("dasdad"))
ƒ => Not(String.IsNullOrWhiteSpace(ƒ.Inside.Inside.A))
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)
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
9.0.0-rc.1 71 10/18/2024
6.2.0 123,042 10/9/2024
6.1.1 87 10/9/2024
6.1.0 47,891 9/29/2024
6.0.24 130 9/11/2024
6.0.23 340,090 7/18/2024
6.0.21 114 6/18/2024
6.0.20 727,725 6/16/2024
6.0.19 30,346 6/14/2024
6.0.18 122 6/14/2024
6.0.17 100 6/14/2024
6.0.16 49,962 6/10/2024
6.0.15 113 6/9/2024
6.0.14 94,234 5/24/2024
6.0.13 118 5/23/2024
6.0.12 99 5/23/2024
6.0.11 112 5/20/2024
6.0.9 84 5/20/2024
6.0.7 79 5/18/2024
6.0.6 134 5/10/2024
6.0.5 130 5/10/2024
6.0.4 549,796 4/3/2024
6.0.3 1,091 3/25/2024
6.0.2 393,559 3/11/2024
6.0.0 1,171,131 11/21/2023
6.0.0-rc.6 107 10/25/2023
6.0.0-rc.5 83 10/25/2023
6.0.0-rc.4 79 10/23/2023
6.0.0-rc.3 68 10/19/2023
6.0.0-rc.2 79 10/18/2023
6.0.0-rc.1 75 10/16/2023
5.0.20 638,577 9/25/2023
5.0.19 923 9/10/2023
5.0.18 901 9/6/2023
5.0.17 884 9/6/2023
5.0.16 950 9/5/2023
5.0.15 893 9/5/2023
5.0.14 866 9/5/2023
5.0.13 862 9/1/2023
5.0.12 898 8/31/2023
5.0.11 870 8/30/2023
5.0.10 881 8/29/2023
5.0.9 901 8/24/2023
5.0.8 921 8/24/2023
5.0.7 450,394 8/23/2023
5.0.6 18,242 8/21/2023
5.0.5 5,063 8/21/2023
5.0.4 930 8/16/2023
5.0.3 213,308 8/2/2023
5.0.2 2,587 8/2/2023
5.0.1 12,381 8/1/2023
5.0.0 12,663 7/31/2023
4.1.26 141,439 7/20/2023
4.1.25 25,426 7/16/2023
4.1.24 398,509 6/13/2023
4.1.23 46,467 6/13/2023
4.1.22 130,278 5/30/2023
4.1.21 56,207 5/20/2023
4.1.20 405,390 4/19/2023
4.1.19 96,209 3/20/2023
4.1.18 1,099 3/20/2023
4.1.17 1,082 3/16/2023
4.1.16 1,087 3/16/2023
4.1.15 1,044 3/15/2023
4.1.14 1,630 3/9/2023
4.1.13 1,071 3/7/2023
4.1.12 1,272 2/10/2023
4.1.11 1,153 1/26/2023
4.1.10 1,140 1/22/2023
4.1.9 1,123 1/20/2023
4.1.8 1,091 1/18/2023
4.1.7 1,295 1/18/2023
4.1.6 1,157 1/17/2023
4.1.1 1,153 1/4/2023
4.1.0 1,207 1/1/2023
3.1.5 1,135 12/21/2022
3.1.3 1,169 12/12/2022
3.1.2 1,123 12/7/2022
3.1.1 1,124 12/7/2022
3.1.0 1,188 12/2/2022
3.0.29 1,168 12/1/2022
3.0.28 1,153 12/1/2022
3.0.27 1,353 11/23/2022
3.0.25 1,199 11/23/2022
3.0.24 1,181 11/18/2022
3.0.23 1,169 11/18/2022
3.0.22 1,214 11/15/2022
3.0.21 1,217 11/14/2022
3.0.20 1,198 11/13/2022
3.0.19 1,429 11/2/2022
3.0.18 1,200 11/2/2022
3.0.17 1,202 10/29/2022
3.0.16 1,216 10/29/2022
3.0.15 1,180 10/29/2022
3.0.14 1,287 10/24/2022
3.0.13 1,261 10/24/2022
3.0.12 1,290 10/17/2022
3.0.11 1,267 10/10/2022
3.0.10 1,295 10/6/2022
3.0.9 1,235 10/6/2022
3.0.8 1,217 10/6/2022
3.0.7 1,245 10/6/2022
3.0.6 1,217 10/5/2022
3.0.5 1,231 10/5/2022
3.0.4 1,195 10/5/2022
3.0.3 1,238 10/3/2022
3.0.2 1,241 9/30/2022
3.0.1 1,229 9/29/2022
2.0.17 1,243 9/29/2022
2.0.16 1,222 9/27/2022
2.0.15 1,338 9/27/2022
2.0.14 1,273 9/26/2022
2.0.13 1,304 9/26/2022
2.0.12 1,287 9/26/2022
2.0.11 1,226 9/25/2022
2.0.10 1,302 9/25/2022
2.0.9 1,307 9/22/2022
2.0.8 1,290 9/22/2022
2.0.6 1,241 9/20/2022
2.0.5 1,264 9/20/2022
2.0.4 1,259 9/20/2022
2.0.2 1,273 9/20/2022
2.0.1 1,358 9/13/2022
2.0.0 1,263 8/19/2022
1.1.24 1,294 7/30/2022
1.1.23 1,262 7/29/2022
1.1.22 1,258 7/29/2022
1.1.21 1,327 7/29/2022
1.1.20 1,291 7/29/2022
1.1.19 1,355 7/27/2022
1.1.17 1,249 7/27/2022
1.1.16 1,297 7/26/2022
1.1.15 1,315 7/25/2022
1.1.14 1,303 7/25/2022
1.1.13 1,251 7/22/2022
1.1.12 1,339 7/19/2022
1.1.11 1,317 7/19/2022
1.1.10 1,284 7/19/2022
1.1.9 1,297 7/19/2022
1.1.8 1,316 7/18/2022
1.1.7 1,293 7/18/2022
1.1.6 1,296 7/18/2022
1.1.5 1,281 7/17/2022
1.1.4 1,309 7/17/2022
1.1.3 1,319 7/17/2022
1.1.2 1,323 7/17/2022
1.1.0 1,312 7/17/2022
1.0.2 1,276 7/15/2022
1.0.1 1,245 7/15/2022
1.0.0 1,290 7/8/2022
0.10.7 1,314 7/7/2022
0.10.2 1,331 7/2/2022
0.10.1 1,260 7/1/2022
0.10.0 1,265 7/1/2022
0.9.11 1,308 6/29/2022
0.9.10 1,310 6/20/2022
0.9.9 1,273 6/11/2022
0.9.7 1,328 6/9/2022
0.9.6 1,279 6/5/2022
0.9.5 1,298 6/3/2022
0.9.4 1,291 6/3/2022
0.9.3 1,265 6/3/2022
0.9.2 1,279 5/31/2022
0.9.1 1,259 5/31/2022
0.9.0 1,259 5/31/2022