Rystem.RepositoryFramework.Api.Server 4.1.8

There is a newer version of this package available.
See the version list below for details.
dotnet add package Rystem.RepositoryFramework.Api.Server --version 4.1.8
                    
NuGet\Install-Package Rystem.RepositoryFramework.Api.Server -Version 4.1.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="Rystem.RepositoryFramework.Api.Server" Version="4.1.8" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Rystem.RepositoryFramework.Api.Server" Version="4.1.8" />
                    
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 4.1.8
                    
#r "nuget: Rystem.RepositoryFramework.Api.Server, 4.1.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.
#addin nuget:?package=Rystem.RepositoryFramework.Api.Server&version=4.1.8
                    
Install as a Cake Addin
#tool nuget:?package=Rystem.RepositoryFramework.Api.Server&version=4.1.8
                    
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 DI for repository with string key for User model, populated with random data in memory, swagger to test the solution, the population method just after the build and the configuration of your API based on repository framework. Futhermore, we are adding a configuration for AAD to implement authentication on api.

var builder = WebApplication.CreateBuilder(args);
builder.Services
    .AddRepositoryInMemoryStorage<User>()
    .PopulateWithRandomData(x => x.Email!, 120, 5);
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.UseApiForRepositoryFramework()
    .WithDefaultAuthorization();
app.Run();

No Authorization flow - default

var builder = WebApplication.CreateBuilder(args);
builder.Services
    .AddRepositoryInMemoryStorage<User>()
    .PopulateWithRandomData(x => x.Email!, 120, 5);
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.UseApiForRepositoryFramework()
    .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
    .AddRepositoryInMemoryStorage<User>()
    .PopulateWithRandomData(x => x.Email!, 120, 5);
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.UseApiForRepositoryFramework()
    .SetPolicyForAll()
    .With("Normal User")
    .And()
    .SetPolicy(RepositoryMethod.Insert)
    .With("Admin")
    .And()
    .SetPolicy(RepositoryMethod.Update)
    .With("Admin")
    .And()
    .Finalize();

app.Run();

In this example, I'm configuring a policy named "Normal User" for all methods and all repositories, and a policy named "Admin" for the methods Insert and Update for all repositories. You can customize it repository for repository, using AddApiForRepository<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 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 was computed.  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.  net9.0 was computed.  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
9.1.2 183,678 5/29/2025
9.1.1 97,723 5/2/2025
9.0.33 156 4/30/2025
9.0.32 186,577 4/15/2025
9.0.31 5,753 4/2/2025
9.0.30 88,781 3/26/2025
9.0.29 8,930 3/18/2025
9.0.28 166 3/17/2025
9.0.27 162 3/16/2025
9.0.26 174 3/13/2025
9.0.25 52,055 3/9/2025
9.0.21 288 3/6/2025
9.0.20 19,514 3/6/2025
9.0.19 240 3/6/2025
9.0.18 224 3/4/2025
9.0.17 135 3/1/2025
9.0.16 119 3/1/2025
9.0.15 75,464 2/22/2025
9.0.14 22,525 2/18/2025
9.0.13 136 2/9/2025
9.0.12 217,653 1/13/2025
9.0.11 23,970 1/9/2025
9.0.10 98 1/9/2025
9.0.9 3,973 1/7/2025
9.0.8 12,467 1/6/2025
9.0.7 110 1/6/2025
9.0.4 92,269 12/23/2024
9.0.3 124 12/22/2024
9.0.2 10,671 12/21/2024
9.0.1 1,157 12/21/2024
9.0.0 173,025 11/16/2024
9.0.0-rc.1 98 10/18/2024
6.2.0 219,012 10/9/2024
6.1.1 148 10/9/2024
6.1.0 47,940 9/29/2024
6.0.24 176 9/11/2024
6.0.23 340,137 7/18/2024
6.0.21 166 6/18/2024
6.0.20 727,767 6/16/2024
6.0.19 30,386 6/14/2024
6.0.18 162 6/14/2024
6.0.17 143 6/14/2024
6.0.16 49,998 6/10/2024
6.0.15 150 6/9/2024
6.0.14 94,276 5/24/2024
6.0.13 188 5/23/2024
6.0.12 137 5/23/2024
6.0.11 156 5/20/2024
6.0.9 122 5/20/2024
6.0.7 116 5/18/2024
6.0.6 171 5/10/2024
6.0.5 166 5/10/2024
6.0.4 549,834 4/3/2024
6.0.3 1,445 3/25/2024
6.0.2 393,596 3/11/2024
6.0.0 1,171,171 11/21/2023
6.0.0-rc.6 135 10/25/2023
6.0.0-rc.5 104 10/25/2023
6.0.0-rc.4 100 10/23/2023
6.0.0-rc.3 92 10/19/2023
6.0.0-rc.2 104 10/18/2023
6.0.0-rc.1 98 10/16/2023
5.0.20 638,606 9/25/2023
5.0.19 955 9/10/2023
5.0.18 938 9/6/2023
5.0.17 920 9/6/2023
5.0.16 979 9/5/2023
5.0.15 936 9/5/2023
5.0.14 899 9/5/2023
5.0.13 896 9/1/2023
5.0.12 927 8/31/2023
5.0.11 901 8/30/2023
5.0.10 917 8/29/2023
5.0.9 950 8/24/2023
5.0.8 963 8/24/2023
5.0.7 450,426 8/23/2023
5.0.6 18,275 8/21/2023
5.0.5 5,104 8/21/2023
5.0.4 961 8/16/2023
5.0.3 213,342 8/2/2023
5.0.2 2,618 8/2/2023
5.0.1 12,431 8/1/2023
5.0.0 12,699 7/31/2023
4.1.26 141,472 7/20/2023
4.1.25 25,461 7/16/2023
4.1.24 398,552 6/13/2023
4.1.23 46,511 6/13/2023
4.1.22 130,337 5/30/2023
4.1.21 56,247 5/20/2023
4.1.20 405,429 4/19/2023
4.1.19 96,249 3/20/2023
4.1.18 1,145 3/20/2023
4.1.17 1,120 3/16/2023
4.1.16 1,129 3/16/2023
4.1.15 1,088 3/15/2023
4.1.14 1,676 3/9/2023
4.1.13 1,114 3/7/2023
4.1.12 1,332 2/10/2023
4.1.11 1,203 1/26/2023
4.1.10 1,186 1/22/2023
4.1.9 1,172 1/20/2023
4.1.8 1,141 1/18/2023
4.1.7 1,341 1/18/2023
4.1.6 1,203 1/17/2023
4.1.1 1,198 1/4/2023
4.1.0 1,253 1/1/2023
3.1.5 1,195 12/21/2022
3.1.3 1,212 12/12/2022
3.1.2 1,166 12/7/2022
3.1.1 1,168 12/7/2022
3.1.0 1,238 12/2/2022
3.0.29 1,219 12/1/2022
3.0.28 1,203 12/1/2022
3.0.27 1,400 11/23/2022
3.0.25 1,255 11/23/2022
3.0.24 1,229 11/18/2022
3.0.23 1,215 11/18/2022
3.0.22 1,262 11/15/2022
3.0.21 1,266 11/14/2022
3.0.20 1,245 11/13/2022
3.0.19 1,487 11/2/2022
3.0.18 1,247 11/2/2022
3.0.17 1,250 10/29/2022
3.0.16 1,262 10/29/2022
3.0.15 1,226 10/29/2022
3.0.14 1,335 10/24/2022
3.0.13 1,311 10/24/2022
3.0.12 1,338 10/17/2022
3.0.11 1,315 10/10/2022
3.0.10 1,354 10/6/2022
3.0.9 1,285 10/6/2022
3.0.8 1,276 10/6/2022
3.0.7 1,294 10/6/2022
3.0.6 1,277 10/5/2022
3.0.5 1,279 10/5/2022
3.0.4 1,246 10/5/2022
3.0.3 1,285 10/3/2022
3.0.2 1,293 9/30/2022
3.0.1 1,277 9/29/2022
2.0.17 1,308 9/29/2022
2.0.16 1,278 9/27/2022
2.0.15 1,385 9/27/2022
2.0.14 1,320 9/26/2022
2.0.13 1,361 9/26/2022
2.0.12 1,335 9/26/2022
2.0.11 1,284 9/25/2022
2.0.10 1,354 9/25/2022
2.0.9 1,360 9/22/2022
2.0.8 1,336 9/22/2022
2.0.6 1,298 9/20/2022
2.0.5 1,315 9/20/2022
2.0.4 1,309 9/20/2022
2.0.2 1,329 9/20/2022
2.0.1 1,409 9/13/2022
2.0.0 1,315 8/19/2022
1.1.24 1,346 7/30/2022
1.1.23 1,316 7/29/2022
1.1.22 1,321 7/29/2022
1.1.21 1,377 7/29/2022
1.1.20 1,346 7/29/2022
1.1.19 1,413 7/27/2022
1.1.17 1,302 7/27/2022
1.1.16 1,349 7/26/2022
1.1.15 1,366 7/25/2022
1.1.14 1,355 7/25/2022
1.1.13 1,307 7/22/2022
1.1.12 1,391 7/19/2022
1.1.11 1,368 7/19/2022
1.1.10 1,359 7/19/2022
1.1.9 1,350 7/19/2022
1.1.8 1,370 7/18/2022
1.1.7 1,344 7/18/2022
1.1.6 1,355 7/18/2022
1.1.5 1,335 7/17/2022
1.1.4 1,378 7/17/2022
1.1.3 1,375 7/17/2022
1.1.2 1,400 7/17/2022
1.1.0 1,363 7/17/2022
1.0.2 1,333 7/15/2022
1.0.1 1,294 7/15/2022
1.0.0 1,344 7/8/2022
0.10.7 1,369 7/7/2022
0.10.2 1,388 7/2/2022
0.10.1 1,312 7/1/2022
0.10.0 1,320 7/1/2022
0.9.11 1,363 6/29/2022
0.9.10 1,364 6/20/2022
0.9.9 1,329 6/11/2022
0.9.7 1,381 6/9/2022
0.9.6 1,335 6/5/2022
0.9.5 1,354 6/3/2022
0.9.4 1,346 6/3/2022
0.9.3 1,334 6/3/2022
0.9.2 1,336 5/31/2022
0.9.1 1,317 5/31/2022
0.9.0 1,311 5/31/2022