Kull.GenericBackend 2.4.0-beta5

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+

Nearly everything can be customized. It's designed to be extensible.

Installation

It's on Nuget: https://www.nuget.org/packages/Kull.GenericBackend/ Basically, just use:

dotnet add package Kull.GenericBackend

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()
            .ConfigureMiddleware(m =>
            { // Set your options
                m.AlwaysWrapJson = true; // Recommended
                m.RequireAuthenticated = true; // default since 2.0. for local development, you might want to use false
            })
            .ConfigureOpenApiGeneration(o =>
            { // Set your options
            })
            .AddFileSupport()
            .AddXmlSupport()
            .AddSystemParameters();
	
	// You might have to register your Provider Factory
	if (!DbProviderFactories.TryGetFactory("Microsoft.Data.SqlClient", out var _))
             DbProviderFactories.RegisterFactory("Microsoft.Data.SqlClient", Microsoft.Data.SqlClient.SqlClientFactory.Instance);
	
		// IMPORTANT: You have to inject a DbConnection somehow
        services.AddTransient(typeof(DbConnection), (s) =>
        {
            var conf = s.GetRequiredService<IConfiguration>();
            var constr = conf["ConnectionStrings:DefaultConnection"];
            return new Microsoft.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 =>
    {
	// Depending on your client, set this to true (eg, ng-swagger-gen)
        o.SerializeAsV2 = false;
    });
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
	app.UseGenericBackend(endpoints);
	endpoints.MapControllerRoute("default", "{controller=Home}/{action=Index}/{id?}");
    });

    // If needed, Swagger UI, see https://github.com/domaindrivendev/Swashbuckle.AspNetCore
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    });

}

In a File called backendconfig.json, set the URI's:

{
   "$schema": "https://raw.githubusercontent.com/Kull-AG/kull-generic-backend/master/backendconfig.schema.json",
   "Entities": {
        "Cases": {
            "Get": "api.spGetSomeCases"
        },
        "Cases/{CaseId|int}/Brands": {
            "Get": "api.spGetBrands",
            "Post": {
                "SP": "api.spAddUpdateBrands",
                "OperationId": "AddOrUpdateBrands",
                "IgnoreParameters":["AParameterMyApiDoesnotCare"],
                "ExecuteParameters": {
                    "ParamterName": "Set this object for strange cases where SQL Server does not return meta",
                    "AnotherParamter": "Be sure not to edit any data."
                }
            }
        },
        "Sample": {
            "GET": {
                "View": "dbo.[use a view if you want]" //  (currently readonly, get only)
            }
        },
        "SampleFunction": {
            "GET": {
                "Function": "dbo.[use a table valued function if you want]" //  (currently readonly, get only)
            }
        }
    }
}

You can place this in appsettings.json as well if you don't like a separate file.

In the "Entities" Section, the URL's are configured. Each entry correspondends to a URL. Each URL can be accessed by multiple HTTP Methods. Common methods 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), but then set the OperationId as seen above
• 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

Further features

For usage on Output Parameters, Table Valued Parameters and multiple Result Sets, view the wiki

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. There is a separate Package for the Metadata: Kull-AG/kull-databasemetadata

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, or remove the default ones, you can do this in startup.cs:

    .AddSystemParameters(prms=>
    {
        prms.Clear();
        //Usually you will want to set global system parameters
        prms.AddSystemParameter("UserClaims", c => Newtonsoft.Json.JsonConvert.SerializeObject(c.User.Claims));
        //But if you want one for just one SP, you can do this by using the dot
        prms.AddSystemParameter("SchemaName.ProcecureName.ParameterNameInThere", c => c.GetType().ToString());
    });

Error Handling

In order to inform the client about an error, use RAISERROR('SOMEERROR', 16,1,1); If there is another exception on the server, code 500 is sent whenever possible. However, when the error occurs during execution and not right at the start, the response will be aborted and the status code cannot be guaranteed. In this case the result will be invalid JSON.

If you want to set the status code, use throw with code 50000 + Http Status Code between 400 and 599:

throw 50503, 'No access to this', 1 

.Net 4.8

It works in theory, but requires a lot of #if's and is not integration-tested. It's used in a number of projects though and does it's job. See wiki

Possible futher development

• Direct manipulation of views without Stored Procedures (while staying secure)
• Support for other databases, eg Sqlite for Testing (Sqlite requires View support)
• Support for Return Codes, though the benefit seems reasonable
• Even More Unit Tests