Kull.GenericBackend
0.13.0
See the version list below for details.
dotnet add package Kull.GenericBackend --version 0.13.0
NuGet\Install-Package Kull.GenericBackend -Version 0.13.0
<PackageReference Include="Kull.GenericBackend" Version="0.13.0" />
paket add Kull.GenericBackend --version 0.13.0
#r "nuget: Kull.GenericBackend, 0.13.0"
// Install Kull.GenericBackend as a Cake Addin #addin nuget:?package=Kull.GenericBackend&version=0.13.0 // Install Kull.GenericBackend as a Cake Tool #tool nuget:?package=Kull.GenericBackend&version=0.13.0
The Kull Generic Backend
This package allows Integration of a generic Stored Procedure-based Backend to Asp.Net MVC Core It uses Swashbuckle, Version 5+
Configuration
In Startup.cs, add the following services:
using Kull.GenericBackend;
// ...
public void ConfigureServices(IServiceCollection services)
{
services.AddMvcCore().AddApiExplorer(); //Or AddMvc() depending on your needs
services.AddGenericBackend(null, new Kull.GenericBackend.SwaggerGeneration.SwaggerFromSPOptions() {
});
// You have to inject a DbConnection somehow
services.AddTransient(typeof(DbConnection), (s) =>
{
var conf = s.GetRequiredService<IConfiguration>();
var constr = conf["ConnectionStrings:DefaultConnection"];
return new System.Data.SqlClient.SqlConnection(constr);
});
services.AddSwaggerGen(c=> {
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
c.AddGenericBackend();
});
}
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
app.UseSwagger(o =>
{
// For compat with ng-swagger-gen on client. You can use ng-openapi-gen if set to false
o.SerializeAsV2 = true;
});
app.UseMvc(routeBuilder=>
{
// The package relies on integrated routing of Asp.net MVC Core
app.UseGenericBackend(routeBuilder);
});
// If needed, Swagger UI
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
}
In appsettings.json, set the connection string and the URI's:
{
"ConnectionStrings": {
"Default": "Data Source=SOMESERVER;Initial Catalog=SOMEDB;Integrated Security=True"
},
"Entities": {
"Cases": {
"Get": "api.spGetSomeCases"
},
"Cases/{CaseId|int}/Brands": {
"Get": "api.spGetBrands",
"Post": "api.spAddUpdateBrands"
}
}
}
In the "Entities" Section, the URL's are configured. Each entry correspondends to a URL. Each URL can be accessed by multiple HTTP Methods. Allowed are:
- GET for getting data, shoud NEVER update something
- POST for adding/updating. Maybe misused for getting data if the url gets longer then 2000 chars otherwise)
- PUT for updating data
- DELETE for deleting data
In the URL there can be route constraints as in MVC, however the | is used instead of : because of limitations of appsettings.json For a full documentation of allowed route constraints, please see here
For best practices for defining a REST Api, see here
Multi-value parameters
To use multiple values for a parameter, use a Sql Server User Defined Table Type for the parameter.
-- Create the data type
CREATE TYPE dbo.IdNameType AS TABLE
(
Id bigint,
Name nvarchar(1000),
PRIMARY KEY (Id)
)
GO
-- Create SP
CREATE PROCEDURE dbo.spTestBackend
@SomeId int,
@Ids dbo.IdNameType readonly
AS
BEGIN
-- ...
END
Main parts of the generic API
Middleware for handling the requests
The main part of the project is the Middleware that handles stored procedures. It is responsible for handling a request against some URL defined in the Entities Section, as seen above.
Middleware for Swagger
The other part is the middleware that is responsible for generating a swagger.json file out of the information of the database. This is done by using the sp_describe_first_result_set and INFORMATION_SCHEMA.parameters
It works by adding an IDocumentFilter to Swashbuckle. Swashbuckle generates the swagger.json This means you can mix this backend and your own Controllers and it will just work in the swagger.json.
Special parameters
There are so called System Parameters, which are parameters defined in any Stored Procedure which should be resolved by the Webserver and not by the Consumer of the API. Built-in are the following System Parameters:
- ADLogin & NTLogin: The Username in the HttpContext
- IPAddress: The IP Adress of the User
- UserAgent: The UserAgent of the Browser
If you would like to add something to this, you can Subclass the SystemParameters class and replace the default implementation by using Asp.Net Core Dependency Injection.
Possible futher development
- Port to .Net Core 3.0
- Direct manipulation of tables/views without Stored Procedures
- Support for other databases, eg Sqlite for Testing
- More Unit Tests
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Kull.Data (>= 5.1.0)
- Kull.DatabaseMetadata (>= 0.9.0)
- Microsoft.AspNetCore.Hosting.Abstractions (>= 2.1.1)
- Microsoft.AspNetCore.Routing (>= 2.1.1)
- Swashbuckle.AspNetCore.SwaggerGen (>= 5.0.0-rc2)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Kull.GenericBackend:
Package | Downloads |
---|---|
Kull.GenericBackend.OData
Package Description |
|
Kull.GenericBackend-Sanitizer
Package Description |
|
Kull.GenericBackend.Sanitizer
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.6.0-alpha | 227 | 12/4/2023 |
2.5.4 | 1,243 | 11/29/2022 |
2.5.3 | 324 | 11/29/2022 |
2.5.2 | 317 | 11/29/2022 |
2.5.1 | 342 | 11/29/2022 |
2.5.0 | 385 | 11/22/2022 |
2.4.2 | 454 | 11/18/2022 |
2.4.1 | 439 | 11/17/2022 |
2.4.0-beta5 | 228 | 9/22/2022 |
2.4.0-beta4 | 152 | 9/22/2022 |
2.4.0-beta3 | 180 | 9/8/2022 |
2.4.0-beta2 | 197 | 7/19/2022 |
2.4.0-beta1 | 168 | 7/19/2022 |
2.3.0 | 868 | 7/1/2022 |
2.2.0-beta9 | 166 | 6/14/2022 |
2.2.0-beta8 | 467 | 5/27/2022 |
2.2.0-beta7 | 201 | 5/4/2022 |
2.2.0-beta6 | 198 | 2/17/2022 |
2.2.0-beta4 | 192 | 2/17/2022 |
2.2.0-beta3 | 227 | 1/19/2022 |
2.2.0-beta2 | 265 | 1/18/2022 |
2.2.0-beta1 | 185 | 1/14/2022 |
2.1.4 | 822 | 1/13/2022 |
2.1.3 | 485 | 1/12/2022 |
2.1.2 | 625 | 1/11/2022 |
2.1.1 | 876 | 12/3/2021 |
2.1.0 | 1,011 | 12/3/2021 |
2.1.0-beta1 | 757 | 12/1/2021 |
2.0.3 | 349 | 12/1/2021 |
2.0.2 | 347 | 12/1/2021 |
2.0.1 | 325 | 12/1/2021 |
2.0.0 | 329 | 11/30/2021 |
2.0.0-beta9 | 4,924 | 11/24/2021 |
2.0.0-beta8 | 258 | 11/13/2021 |
2.0.0-beta7 | 387 | 10/25/2021 |
2.0.0-beta6 | 227 | 10/25/2021 |
2.0.0-beta5 | 279 | 10/25/2021 |
2.0.0-beta4 | 218 | 10/6/2021 |
2.0.0-beta3 | 254 | 10/5/2021 |
2.0.0-beta2 | 262 | 9/30/2021 |
1.5.3 | 454 | 8/13/2021 |
1.5.2 | 384 | 8/11/2021 |
1.5.1 | 423 | 8/9/2021 |
1.5.0 | 499 | 8/1/2021 |
1.4.4 | 496 | 8/1/2021 |
1.4.3 | 467 | 7/29/2021 |
1.4.2 | 549 | 4/13/2021 |
1.4.1 | 401 | 4/13/2021 |
1.4.0 | 424 | 4/6/2021 |
1.3.9 | 419 | 2/11/2021 |
1.3.8 | 570 | 1/25/2021 |
1.3.7 | 438 | 1/15/2021 |
1.3.6 | 443 | 1/15/2021 |
1.3.5 | 559 | 12/8/2020 |
1.3.4 | 482 | 12/8/2020 |
1.3.2 | 665 | 9/9/2020 |
1.3.1 | 546 | 9/9/2020 |
1.3.0 | 530 | 8/19/2020 |
1.2.4 | 549 | 8/18/2020 |
1.2.3 | 579 | 8/12/2020 |
1.2.2 | 506 | 8/12/2020 |
1.2.1 | 541 | 7/16/2020 |
1.2.0 | 539 | 7/16/2020 |
1.1.0 | 649 | 6/1/2020 |
1.1.0-beta3 | 364 | 5/25/2020 |
1.1.0-beta2 | 344 | 5/20/2020 |
1.1.0-beta1 | 331 | 5/20/2020 |
1.1.0-alpha3 | 354 | 5/20/2020 |
1.1.0-alpha2 | 358 | 5/20/2020 |
1.1.0-alpha1 | 353 | 5/20/2020 |
1.0.0-rc3 | 343 | 5/19/2020 |
1.0.0-rc2 | 341 | 5/14/2020 |
1.0.0-rc1 | 309 | 5/14/2020 |
1.0.0-beta3 | 359 | 5/6/2020 |
1.0.0-beta2 | 358 | 5/4/2020 |
1.0.0-beta1 | 371 | 4/30/2020 |
0.15.4 | 664 | 3/18/2020 |
0.15.3 | 606 | 3/18/2020 |
0.14.2 | 660 | 11/22/2019 |
0.14.1 | 1,231 | 10/2/2019 |
0.13.5 | 633 | 9/25/2019 |
0.13.4 | 632 | 9/12/2019 |
0.13.3 | 598 | 9/11/2019 |
0.13.2 | 599 | 9/10/2019 |
0.13.1 | 620 | 9/10/2019 |
0.13.0 | 666 | 8/14/2019 |