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.
#:package Rystem.RepositoryFramework.Api.Server@4.1.8
                    
#: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=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 261,649 5/29/2025
9.1.1 97,735 5/2/2025
9.0.33 164 4/30/2025
9.0.32 186,587 4/15/2025
9.0.31 5,764 4/2/2025
9.0.30 88,788 3/26/2025
9.0.29 8,944 3/18/2025
9.0.28 175 3/17/2025
9.0.27 173 3/16/2025
9.0.26 183 3/13/2025
9.0.25 52,066 3/9/2025
9.0.21 301 3/6/2025
9.0.20 19,524 3/6/2025
9.0.19 250 3/6/2025
9.0.18 234 3/4/2025
9.0.17 148 3/1/2025
9.0.16 132 3/1/2025
9.0.15 75,473 2/22/2025
9.0.14 22,537 2/18/2025
9.0.13 150 2/9/2025
9.0.12 217,660 1/13/2025
9.0.11 23,981 1/9/2025
9.0.10 108 1/9/2025
9.0.9 3,980 1/7/2025
9.0.8 12,476 1/6/2025
9.0.7 117 1/6/2025
9.0.4 92,279 12/23/2024
9.0.3 136 12/22/2024
9.0.2 10,682 12/21/2024
9.0.1 1,170 12/21/2024
9.0.0 173,036 11/16/2024
9.0.0-rc.1 102 10/18/2024
6.2.0 219,019 10/9/2024
6.1.1 158 10/9/2024
6.1.0 47,951 9/29/2024
6.0.24 189 9/11/2024
6.0.23 340,145 7/18/2024
6.0.21 179 6/18/2024
6.0.20 727,773 6/16/2024
6.0.19 30,396 6/14/2024
6.0.18 171 6/14/2024
6.0.17 151 6/14/2024
6.0.16 50,004 6/10/2024
6.0.15 156 6/9/2024
6.0.14 94,286 5/24/2024
6.0.13 200 5/23/2024
6.0.12 146 5/23/2024
6.0.11 163 5/20/2024
6.0.9 134 5/20/2024
6.0.7 123 5/18/2024
6.0.6 182 5/10/2024
6.0.5 179 5/10/2024
6.0.4 549,840 4/3/2024
6.0.3 1,453 3/25/2024
6.0.2 393,605 3/11/2024
6.0.0 1,171,180 11/21/2023
6.0.0-rc.6 143 10/25/2023
6.0.0-rc.5 107 10/25/2023
6.0.0-rc.4 107 10/23/2023
6.0.0-rc.3 98 10/19/2023
6.0.0-rc.2 110 10/18/2023
6.0.0-rc.1 103 10/16/2023
5.0.20 638,615 9/25/2023
5.0.19 959 9/10/2023
5.0.18 947 9/6/2023
5.0.17 929 9/6/2023
5.0.16 988 9/5/2023
5.0.15 945 9/5/2023
5.0.14 907 9/5/2023
5.0.13 904 9/1/2023
5.0.12 934 8/31/2023
5.0.11 911 8/30/2023
5.0.10 926 8/29/2023
5.0.9 956 8/24/2023
5.0.8 978 8/24/2023
5.0.7 450,433 8/23/2023
5.0.6 18,285 8/21/2023
5.0.5 5,113 8/21/2023
5.0.4 974 8/16/2023
5.0.3 213,353 8/2/2023
5.0.2 2,624 8/2/2023
5.0.1 12,445 8/1/2023
5.0.0 12,705 7/31/2023
4.1.26 141,478 7/20/2023
4.1.25 25,470 7/16/2023
4.1.24 398,561 6/13/2023
4.1.23 46,517 6/13/2023
4.1.22 130,343 5/30/2023
4.1.21 56,253 5/20/2023
4.1.20 405,436 4/19/2023
4.1.19 96,258 3/20/2023
4.1.18 1,152 3/20/2023
4.1.17 1,130 3/16/2023
4.1.16 1,135 3/16/2023
4.1.15 1,099 3/15/2023
4.1.14 1,685 3/9/2023
4.1.13 1,120 3/7/2023
4.1.12 1,341 2/10/2023
4.1.11 1,212 1/26/2023
4.1.10 1,196 1/22/2023
4.1.9 1,182 1/20/2023
4.1.8 1,147 1/18/2023
4.1.7 1,349 1/18/2023
4.1.6 1,212 1/17/2023
4.1.1 1,204 1/4/2023
4.1.0 1,263 1/1/2023
3.1.5 1,203 12/21/2022
3.1.3 1,218 12/12/2022
3.1.2 1,176 12/7/2022
3.1.1 1,177 12/7/2022
3.1.0 1,244 12/2/2022
3.0.29 1,230 12/1/2022
3.0.28 1,211 12/1/2022
3.0.27 1,407 11/23/2022
3.0.25 1,267 11/23/2022
3.0.24 1,241 11/18/2022
3.0.23 1,225 11/18/2022
3.0.22 1,273 11/15/2022
3.0.21 1,274 11/14/2022
3.0.20 1,254 11/13/2022
3.0.19 1,496 11/2/2022
3.0.18 1,254 11/2/2022
3.0.17 1,263 10/29/2022
3.0.16 1,272 10/29/2022
3.0.15 1,233 10/29/2022
3.0.14 1,347 10/24/2022
3.0.13 1,318 10/24/2022
3.0.12 1,348 10/17/2022
3.0.11 1,326 10/10/2022
3.0.10 1,363 10/6/2022
3.0.9 1,292 10/6/2022
3.0.8 1,283 10/6/2022
3.0.7 1,303 10/6/2022
3.0.6 1,288 10/5/2022
3.0.5 1,290 10/5/2022
3.0.4 1,260 10/5/2022
3.0.3 1,297 10/3/2022
3.0.2 1,303 9/30/2022
3.0.1 1,289 9/29/2022
2.0.17 1,315 9/29/2022
2.0.16 1,289 9/27/2022
2.0.15 1,396 9/27/2022
2.0.14 1,328 9/26/2022
2.0.13 1,372 9/26/2022
2.0.12 1,342 9/26/2022
2.0.11 1,295 9/25/2022
2.0.10 1,366 9/25/2022
2.0.9 1,369 9/22/2022
2.0.8 1,347 9/22/2022
2.0.6 1,308 9/20/2022
2.0.5 1,327 9/20/2022
2.0.4 1,319 9/20/2022
2.0.2 1,336 9/20/2022
2.0.1 1,420 9/13/2022
2.0.0 1,336 8/19/2022
1.1.24 1,366 7/30/2022
1.1.23 1,322 7/29/2022
1.1.22 1,335 7/29/2022
1.1.21 1,384 7/29/2022
1.1.20 1,356 7/29/2022
1.1.19 1,424 7/27/2022
1.1.17 1,309 7/27/2022
1.1.16 1,357 7/26/2022
1.1.15 1,377 7/25/2022
1.1.14 1,366 7/25/2022
1.1.13 1,320 7/22/2022
1.1.12 1,402 7/19/2022
1.1.11 1,376 7/19/2022
1.1.10 1,367 7/19/2022
1.1.9 1,361 7/19/2022
1.1.8 1,385 7/18/2022
1.1.7 1,356 7/18/2022
1.1.6 1,366 7/18/2022
1.1.5 1,346 7/17/2022
1.1.4 1,390 7/17/2022
1.1.3 1,387 7/17/2022
1.1.2 1,412 7/17/2022
1.1.0 1,371 7/17/2022
1.0.2 1,348 7/15/2022
1.0.1 1,305 7/15/2022
1.0.0 1,355 7/8/2022
0.10.7 1,378 7/7/2022
0.10.2 1,395 7/2/2022
0.10.1 1,322 7/1/2022
0.10.0 1,330 7/1/2022
0.9.11 1,372 6/29/2022
0.9.10 1,372 6/20/2022
0.9.9 1,338 6/11/2022
0.9.7 1,395 6/9/2022
0.9.6 1,346 6/5/2022
0.9.5 1,367 6/3/2022
0.9.4 1,358 6/3/2022
0.9.3 1,343 6/3/2022
0.9.2 1,349 5/31/2022
0.9.1 1,331 5/31/2022
0.9.0 1,324 5/31/2022