Rystem.RepositoryFramework.Api.Server 2.0.4

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

app.AddApiForRepositoryFramework()
   .WithNoAuthorization();

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

You may add api for each service by

public static ApiAuthorizationBuilder AddApiForRepository<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.

var builder = WebApplication.CreateBuilder(args);
builder.Services
    .AddRepositoryInMemoryStorage<User>()
    .PopulateWithRandomData(x => x.Email!, 120, 5);
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen();

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

Authorization flow - default

You have to configure an identity provider, for example Azure Active Directory and the middlewares UseAuthentication(), UseAuthorization(). Now you can use the default identity, without policies. Here an example with an API with AAD configured.

var builder = WebApplication.CreateBuilder(args);
var configurationSection = builder.Configuration.GetSection("AzureAd");
var scopes = builder.Configuration["AzureAd:Scopes"];
builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
    .AddMicrosoftIdentityWebApi(configurationSection);

builder.Services
    .AddRepositoryInMemoryStorage<User>()
    .PopulateWithRandomData(x => x.Email!, 120, 5);
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen();

var app = builder.Build();
app.Services.Populate();
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
app.UseHttpsRedirection();
app.AddApiForRepositoryFramework()
    .WithDefaultAuthorization();

app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
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);
var configurationSection = builder.Configuration.GetSection("AzureAd");
var scopes = builder.Configuration["AzureAd:Scopes"];
builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
    .AddMicrosoftIdentityWebApi(configurationSection);

builder.Services
    .AddRepositoryInMemoryStorage<User>()
    .PopulateWithRandomData(x => x.Email!, 120, 5);
    builder.Services.AddEndpointsApiExplorer();
    builder.Services.AddSwaggerGen();

var app = builder.Build();
app.Services.Populate();
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}
app.UseHttpsRedirection();
app.AddApiForRepositoryFramework()
    .SetPolicyForAll()
    .With("Normal User")
    .And()
    .SetPolicy(RepositoryMethod.Insert)
    .With("Admin")
    .And()
    .SetPolicy(RepositoryMethod.Update)
    .With("Admin")
    .And()
    .Finalize();

app.UseRouting();
app.UseAuthentication();
app.UseAuthorization();
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 query 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 net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  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 221,761 5/29/2025
9.1.1 97,728 5/2/2025
9.0.33 159 4/30/2025
9.0.32 186,579 4/15/2025
9.0.31 5,756 4/2/2025
9.0.30 88,783 3/26/2025
9.0.29 8,934 3/18/2025
9.0.28 169 3/17/2025
9.0.27 164 3/16/2025
9.0.26 177 3/13/2025
9.0.25 52,057 3/9/2025
9.0.21 292 3/6/2025
9.0.20 19,518 3/6/2025
9.0.19 242 3/6/2025
9.0.18 228 3/4/2025
9.0.17 139 3/1/2025
9.0.16 125 3/1/2025
9.0.15 75,467 2/22/2025
9.0.14 22,529 2/18/2025
9.0.13 140 2/9/2025
9.0.12 217,655 1/13/2025
9.0.11 23,974 1/9/2025
9.0.10 100 1/9/2025
9.0.9 3,975 1/7/2025
9.0.8 12,469 1/6/2025
9.0.7 112 1/6/2025
9.0.4 92,272 12/23/2024
9.0.3 127 12/22/2024
9.0.2 10,674 12/21/2024
9.0.1 1,161 12/21/2024
9.0.0 173,028 11/16/2024
9.0.0-rc.1 99 10/18/2024
6.2.0 219,014 10/9/2024
6.1.1 151 10/9/2024
6.1.0 47,944 9/29/2024
6.0.24 181 9/11/2024
6.0.23 340,140 7/18/2024
6.0.21 171 6/18/2024
6.0.20 727,769 6/16/2024
6.0.19 30,389 6/14/2024
6.0.18 166 6/14/2024
6.0.17 146 6/14/2024
6.0.16 50,000 6/10/2024
6.0.15 152 6/9/2024
6.0.14 94,278 5/24/2024
6.0.13 191 5/23/2024
6.0.12 141 5/23/2024
6.0.11 158 5/20/2024
6.0.9 126 5/20/2024
6.0.7 119 5/18/2024
6.0.6 176 5/10/2024
6.0.5 171 5/10/2024
6.0.4 549,836 4/3/2024
6.0.3 1,448 3/25/2024
6.0.2 393,599 3/11/2024
6.0.0 1,171,173 11/21/2023
6.0.0-rc.6 136 10/25/2023
6.0.0-rc.5 104 10/25/2023
6.0.0-rc.4 103 10/23/2023
6.0.0-rc.3 92 10/19/2023
6.0.0-rc.2 106 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 940 9/6/2023
5.0.17 923 9/6/2023
5.0.16 981 9/5/2023
5.0.15 938 9/5/2023
5.0.14 900 9/5/2023
5.0.13 897 9/1/2023
5.0.12 930 8/31/2023
5.0.11 904 8/30/2023
5.0.10 920 8/29/2023
5.0.9 951 8/24/2023
5.0.8 973 8/24/2023
5.0.7 450,428 8/23/2023
5.0.6 18,277 8/21/2023
5.0.5 5,106 8/21/2023
5.0.4 965 8/16/2023
5.0.3 213,345 8/2/2023
5.0.2 2,619 8/2/2023
5.0.1 12,435 8/1/2023
5.0.0 12,700 7/31/2023
4.1.26 141,473 7/20/2023
4.1.25 25,463 7/16/2023
4.1.24 398,554 6/13/2023
4.1.23 46,512 6/13/2023
4.1.22 130,338 5/30/2023
4.1.21 56,248 5/20/2023
4.1.20 405,430 4/19/2023
4.1.19 96,251 3/20/2023
4.1.18 1,147 3/20/2023
4.1.17 1,122 3/16/2023
4.1.16 1,130 3/16/2023
4.1.15 1,091 3/15/2023
4.1.14 1,678 3/9/2023
4.1.13 1,115 3/7/2023
4.1.12 1,333 2/10/2023
4.1.11 1,205 1/26/2023
4.1.10 1,189 1/22/2023
4.1.9 1,174 1/20/2023
4.1.8 1,142 1/18/2023
4.1.7 1,344 1/18/2023
4.1.6 1,205 1/17/2023
4.1.1 1,199 1/4/2023
4.1.0 1,256 1/1/2023
3.1.5 1,198 12/21/2022
3.1.3 1,213 12/12/2022
3.1.2 1,168 12/7/2022
3.1.1 1,171 12/7/2022
3.1.0 1,239 12/2/2022
3.0.29 1,222 12/1/2022
3.0.28 1,205 12/1/2022
3.0.27 1,402 11/23/2022
3.0.25 1,259 11/23/2022
3.0.24 1,231 11/18/2022
3.0.23 1,217 11/18/2022
3.0.22 1,264 11/15/2022
3.0.21 1,268 11/14/2022
3.0.20 1,247 11/13/2022
3.0.19 1,488 11/2/2022
3.0.18 1,249 11/2/2022
3.0.17 1,253 10/29/2022
3.0.16 1,264 10/29/2022
3.0.15 1,227 10/29/2022
3.0.14 1,338 10/24/2022
3.0.13 1,312 10/24/2022
3.0.12 1,339 10/17/2022
3.0.11 1,318 10/10/2022
3.0.10 1,356 10/6/2022
3.0.9 1,286 10/6/2022
3.0.8 1,277 10/6/2022
3.0.7 1,295 10/6/2022
3.0.6 1,279 10/5/2022
3.0.5 1,282 10/5/2022
3.0.4 1,249 10/5/2022
3.0.3 1,288 10/3/2022
3.0.2 1,294 9/30/2022
3.0.1 1,278 9/29/2022
2.0.17 1,309 9/29/2022
2.0.16 1,281 9/27/2022
2.0.15 1,386 9/27/2022
2.0.14 1,321 9/26/2022
2.0.13 1,364 9/26/2022
2.0.12 1,336 9/26/2022
2.0.11 1,285 9/25/2022
2.0.10 1,356 9/25/2022
2.0.9 1,363 9/22/2022
2.0.8 1,338 9/22/2022
2.0.6 1,301 9/20/2022
2.0.5 1,318 9/20/2022
2.0.4 1,310 9/20/2022
2.0.2 1,330 9/20/2022
2.0.1 1,413 9/13/2022
2.0.0 1,316 8/19/2022
1.1.24 1,348 7/30/2022
1.1.23 1,317 7/29/2022
1.1.22 1,323 7/29/2022
1.1.21 1,378 7/29/2022
1.1.20 1,347 7/29/2022
1.1.19 1,415 7/27/2022
1.1.17 1,303 7/27/2022
1.1.16 1,350 7/26/2022
1.1.15 1,368 7/25/2022
1.1.14 1,357 7/25/2022
1.1.13 1,309 7/22/2022
1.1.12 1,394 7/19/2022
1.1.11 1,369 7/19/2022
1.1.10 1,360 7/19/2022
1.1.9 1,352 7/19/2022
1.1.8 1,372 7/18/2022
1.1.7 1,347 7/18/2022
1.1.6 1,357 7/18/2022
1.1.5 1,338 7/17/2022
1.1.4 1,379 7/17/2022
1.1.3 1,378 7/17/2022
1.1.2 1,402 7/17/2022
1.1.0 1,364 7/17/2022
1.0.2 1,336 7/15/2022
1.0.1 1,295 7/15/2022
1.0.0 1,346 7/8/2022
0.10.7 1,371 7/7/2022
0.10.2 1,389 7/2/2022
0.10.1 1,313 7/1/2022
0.10.0 1,321 7/1/2022
0.9.11 1,365 6/29/2022
0.9.10 1,365 6/20/2022
0.9.9 1,330 6/11/2022
0.9.7 1,383 6/9/2022
0.9.6 1,337 6/5/2022
0.9.5 1,355 6/3/2022
0.9.4 1,348 6/3/2022
0.9.3 1,335 6/3/2022
0.9.2 1,339 5/31/2022
0.9.1 1,319 5/31/2022
0.9.0 1,313 5/31/2022