Rystem.RepositoryFramework.Api.Server 9.0.26

There is a newer version of this package available.
See the version list below for details.
dotnet add package Rystem.RepositoryFramework.Api.Server --version 9.0.26
                    
NuGet\Install-Package Rystem.RepositoryFramework.Api.Server -Version 9.0.26
                    
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="9.0.26" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Rystem.RepositoryFramework.Api.Server" Version="9.0.26" />
                    
Directory.Packages.props
<PackageReference Include="Rystem.RepositoryFramework.Api.Server" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Rystem.RepositoryFramework.Api.Server --version 9.0.26
                    
#r "nuget: Rystem.RepositoryFramework.Api.Server, 9.0.26"
                    
#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.
#:package Rystem.RepositoryFramework.Api.Server@9.0.26
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Rystem.RepositoryFramework.Api.Server&version=9.0.26
                    
Install as a Cake Addin
#tool nuget:?package=Rystem.RepositoryFramework.Api.Server&version=9.0.26
                    
Install as a Cake Tool

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 net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.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
10.0.1 60,585 11/12/2025
9.1.3 278 9/2/2025
9.1.2 764,540 5/29/2025
9.1.1 97,823 5/2/2025
9.0.33 238 4/30/2025
9.0.32 186,680 4/15/2025
9.0.31 5,855 4/2/2025
9.0.30 88,891 3/26/2025
9.0.29 9,034 3/18/2025
9.0.28 252 3/17/2025
9.0.27 259 3/16/2025
9.0.26 255 3/13/2025
9.0.25 52,166 3/9/2025
9.0.21 385 3/6/2025
9.0.20 19,613 3/6/2025
9.0.19 342 3/6/2025
9.0.18 327 3/4/2025
9.0.17 228 3/1/2025
9.0.16 229 3/1/2025
9.0.15 75,570 2/22/2025
9.0.14 22,616 2/18/2025
9.0.13 247 2/9/2025
9.0.12 217,729 1/13/2025
9.0.11 24,073 1/9/2025
9.0.10 196 1/9/2025
9.0.9 4,050 1/7/2025
9.0.8 12,568 1/6/2025
9.0.7 187 1/6/2025
9.0.4 92,366 12/23/2024
9.0.3 233 12/22/2024
9.0.2 10,775 12/21/2024
9.0.1 1,253 12/21/2024
9.0.0 173,120 11/16/2024
9.0.0-rc.1 145 10/18/2024
6.2.0 219,088 10/9/2024
6.1.1 238 10/9/2024
6.1.0 48,034 9/29/2024
6.0.24 298 9/11/2024
6.0.23 340,240 7/18/2024
6.0.21 263 6/18/2024
6.0.20 727,841 6/16/2024
6.0.19 30,496 6/14/2024
6.0.18 267 6/14/2024
6.0.17 243 6/14/2024
6.0.16 50,083 6/10/2024
6.0.15 232 6/9/2024
6.0.14 94,377 5/24/2024
6.0.13 281 5/23/2024
6.0.12 240 5/23/2024
6.0.11 264 5/20/2024
6.0.9 219 5/20/2024
6.0.7 191 5/18/2024
6.0.6 266 5/10/2024
6.0.5 265 5/10/2024
6.0.4 549,909 4/3/2024
6.0.3 1,545 3/25/2024
6.0.2 393,694 3/11/2024
6.0.0 1,171,255 11/21/2023
6.0.0-rc.6 184 10/25/2023
6.0.0-rc.5 138 10/25/2023
6.0.0-rc.4 147 10/23/2023
6.0.0-rc.3 134 10/19/2023
6.0.0-rc.2 157 10/18/2023
6.0.0-rc.1 138 10/16/2023
5.0.20 638,678 9/25/2023
5.0.19 1,035 9/10/2023
5.0.18 1,019 9/6/2023
5.0.17 1,005 9/6/2023
5.0.16 1,066 9/5/2023
5.0.15 1,021 9/5/2023
5.0.14 980 9/5/2023
5.0.13 982 9/1/2023
5.0.12 1,004 8/31/2023
5.0.11 998 8/30/2023
5.0.10 994 8/29/2023
5.0.9 1,013 8/24/2023
5.0.8 1,039 8/24/2023
5.0.7 450,488 8/23/2023
5.0.6 18,360 8/21/2023
5.0.5 5,186 8/21/2023
5.0.4 1,048 8/16/2023
5.0.3 213,436 8/2/2023
5.0.2 2,692 8/2/2023
5.0.1 12,525 8/1/2023
5.0.0 12,763 7/31/2023
4.1.26 141,551 7/20/2023
4.1.25 25,552 7/16/2023
4.1.24 398,646 6/13/2023
4.1.23 46,607 6/13/2023
4.1.22 130,440 5/30/2023
4.1.21 56,329 5/20/2023
4.1.20 405,532 4/19/2023
4.1.19 96,357 3/20/2023
4.1.18 1,245 3/20/2023
4.1.17 1,229 3/16/2023
4.1.16 1,214 3/16/2023
4.1.15 1,198 3/15/2023
4.1.14 1,779 3/9/2023
4.1.13 1,206 3/7/2023
4.1.12 1,439 2/10/2023
4.1.11 1,310 1/26/2023
4.1.10 1,293 1/22/2023
4.1.9 1,275 1/20/2023
4.1.8 1,227 1/18/2023
4.1.7 1,460 1/18/2023
4.1.6 1,327 1/17/2023
4.1.1 1,306 1/4/2023
4.1.0 1,358 1/1/2023
3.1.5 1,296 12/21/2022
3.1.3 1,304 12/12/2022
3.1.2 1,287 12/7/2022
3.1.1 1,286 12/7/2022
3.1.0 1,332 12/2/2022
3.0.29 1,321 12/1/2022
3.0.28 1,310 12/1/2022
3.0.27 1,486 11/23/2022
3.0.25 1,363 11/23/2022
3.0.24 1,341 11/18/2022
3.0.23 1,328 11/18/2022
3.0.22 1,368 11/15/2022
3.0.21 1,367 11/14/2022
3.0.20 1,384 11/13/2022
3.0.19 1,586 11/2/2022
3.0.18 1,345 11/2/2022
3.0.17 1,363 10/29/2022
3.0.16 1,367 10/29/2022
3.0.15 1,322 10/29/2022
3.0.14 1,449 10/24/2022
3.0.13 1,401 10/24/2022
3.0.12 1,445 10/17/2022
3.0.11 1,444 10/10/2022
3.0.10 1,462 10/6/2022
3.0.9 1,376 10/6/2022
3.0.8 1,368 10/6/2022
3.0.7 1,400 10/6/2022
3.0.6 1,392 10/5/2022
3.0.5 1,388 10/5/2022
3.0.4 1,362 10/5/2022
3.0.3 1,405 10/3/2022
3.0.2 1,401 9/30/2022
3.0.1 1,396 9/29/2022
2.0.17 1,406 9/29/2022
2.0.16 1,395 9/27/2022
2.0.15 1,488 9/27/2022
2.0.14 1,420 9/26/2022
2.0.13 1,481 9/26/2022
2.0.12 1,429 9/26/2022
2.0.11 1,408 9/25/2022
2.0.10 1,484 9/25/2022
2.0.9 1,476 9/22/2022
2.0.8 1,454 9/22/2022
2.0.6 1,413 9/20/2022
2.0.5 1,437 9/20/2022
2.0.4 1,425 9/20/2022
2.0.2 1,427 9/20/2022
2.0.1 1,525 9/13/2022
2.0.0 1,444 8/19/2022
1.1.24 1,463 7/30/2022
1.1.23 1,416 7/29/2022
1.1.22 1,438 7/29/2022
1.1.21 1,474 7/29/2022
1.1.20 1,456 7/29/2022
1.1.19 1,538 7/27/2022
1.1.17 1,415 7/27/2022
1.1.16 1,450 7/26/2022
1.1.15 1,482 7/25/2022
1.1.14 1,475 7/25/2022
1.1.13 1,424 7/22/2022
1.1.12 1,506 7/19/2022
1.1.11 1,469 7/19/2022
1.1.10 1,467 7/19/2022
1.1.9 1,475 7/19/2022
1.1.8 1,493 7/18/2022
1.1.7 1,460 7/18/2022
1.1.6 1,475 7/18/2022
1.1.5 1,449 7/17/2022
1.1.4 1,492 7/17/2022
1.1.3 1,497 7/17/2022
1.1.2 1,516 7/17/2022
1.1.0 1,459 7/17/2022
1.0.2 1,467 7/15/2022
1.0.1 1,415 7/15/2022
1.0.0 1,467 7/8/2022
0.10.7 1,481 7/7/2022
0.10.2 1,503 7/2/2022
0.10.1 1,436 7/1/2022
0.10.0 1,451 7/1/2022
0.9.11 1,485 6/29/2022
0.9.10 1,463 6/20/2022
0.9.9 1,438 6/11/2022
0.9.7 1,502 6/9/2022
0.9.6 1,456 6/5/2022
0.9.5 1,474 6/3/2022
0.9.4 1,465 6/3/2022
0.9.3 1,440 6/3/2022
0.9.2 1,452 5/31/2022
0.9.1 1,465 5/31/2022
0.9.0 1,434 5/31/2022