proudmonkey / apiboilerplate Goto Github PK

Some personal opinions after having used this template for a new API.

For the new version of this BoilerPlate I would suggest not including so much "extras", at least not extras that are enabled by default. While it might be useful, it has the side effect of turning this boilerplate template more into a code sample/tutorial than something you can use to get a quick start. This as you would have to spend about as much time trying to understand how those extras work as well as removing them if you don't use it, as it would take to configure a new API from scratch and configure health checks etc.

I think this might turn away potential users of this excellent template, that really offers a lot of value. Well, that's my personal opinions, others might disagree :)

How to use API Authentication with social network or Azure B2C?

Can we add support for JWT Auth scheme and related configuration with Authorization Role, Police, permission etc.

ApiBoilerPlate project template is very good and has lots of things which required for most projects.

As most of the project is using username and password and based on that they generate JWT Token.
However in provided sample it's using API key and secret which is only used for one client it can be used as daemon service As per my understanding.

For API Project most people are not using IdentityServer due to lots of complexity and configuration instead use custom or dotnetcore identity authentication with JWT scheme for API Project.

I read and AuthServerConnect class.
Which idea is behind it? How to use?

Good sample but I can't figure out what I call to get a token that I can then .. I guess put in the header using fiddler to call the protected API . Help ?

When Will be the update for .NET Core 5?

Trying to upgrade Nuget packages to latest version seem to break HealthChecks. You get a lot of different build errors, some which I was unable to figure out without commenting out a lot of code. Problems can be seen by just running the solution after upgrading.

First, THANK YOU for creating and sharing the template.

Background: The ApiBoilerPlate was used to generate a WebAPI project. After adding [Authorize] attribute to the PersonsController, the endpoints require to Bearer JWT access token as expected. However, accessing any endpoint in the PersonsController will get 401.

Issue - Para authorization and bearer token are not included in the header upon submit in Swagger. External testing using Postman worked fine.

Fix - Made the following changes in Infrastructure\Installers\RegisterSwagger.cs

            options.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
            {
                Scheme = "Bearer",
                Description = "Enter 'Bearer' following by space and JWT.",
                Name = "Authorization",
                //Type = SecuritySchemeType.Http,
                Type = SecuritySchemeType.ApiKey,
                In = ParameterLocation.Header,
            });

See below for the code -
https://github.com/workcontrolgit/EmployeeProfileWebAPIDemo/blob/master/EmployeeProfile/EmployeeProfile/Infrastructure/Installers/RegisterSwagger.cs

I will fork and submit a pull request.

Vincent,
Happy New year 2022, I have same questions as others, is there a plan to update this to .NET 6 ?

Info: Which is a good ReactJS panel to add to manange models and CRUD that would be added to this project? I wish to manage data like Strapi.io/Directus.io and with WebApi get/put json data as backend.

I have installed the template form extensions menu of visual studio and created a new project. I also created a table in my database and updated the connection string in appSettings.json file. when i run the project i see the following error in my browser as shown in the image.

HTTP Error 500.24 - Internal Server Error
An ASP.NET setting has been detected that does not apply in Integrated managed pipeline mode.

Most likely causes:
system.web/identity@impersonate is set to true.

Things you can try:
If the application supports it, disable client impersonation.
If you are certain that it is OK to ignore this error, it can be disabled by setting system.webServer/validation@validateIntegratedModeConfiguration to false.

If you run into problems like this after updating AspNetCoreRateLimit (or have it updated for you by another NuGet package):

System.InvalidOperationException: Unable to resolve service for type 'AspNetCoreRateLimit.IProcessingStrategy' while attempting to activate 'AspNetCoreRateLimit.IpRateLimitMiddleware'.

This is the solution needed to get it working again:

        // See release notes for 4.0.0 https://github.com/stefanprodan/AspNetCoreRateLimit/releases
        services.AddSingleton<IProcessingStrategy, AsyncKeyLockProcessingStrategy>();

In RegisterRequestRateLimiter class

Hi,

I not understand if identity server is into this template or I've to create an external project and put in.
Could you explain?
Thanks.

Great effort! However, how do I create a Windows Service from the resultant exe file? Almost nowhere in the web that I can find, are there clear instructions for running a WebApi based on Net Core 3.1 as a Windows Service using either Kestrel or Http.Sys as the self host.
Our applications and WebAPIs have to be installed and run at our customers' sites and most tutorials and blogs that I can find provide little or no help with Publish and Deploy to third parties who may or may not have strong Devops skills. I have found some good ideas for changing the Program.cs to recognise if the app is running in debug mode or as a Windows Service, but these mostly apply to .Net Framework bases.
Can you add some information regarding this?

Hi, I would be grateful if you could show small sample on how to integrate this with an angular 2+ client application.

Thanks.

If you upgrade HealthCheck to 3.1.3

you have to change the class class RegisterHealthChecks : IServiceRegistration

string DbConnectionString = config.GetConnectionString("HealthCheckDatabaseConnectionString");
services.AddHealthChecksUI().AddInMemoryStorage();
//.AddSqliteStorage(DbConnectionString);

I start the project and try to open HealthChecksUI. I don't see the UI.

"HealthChecksUI": { "HealthChecks": [ { "Name": "HTTP-Api-Basic", "Uri": "https://localhost:5001/selfcheck" } ], "Webhooks": [ { "Name": "", "Uri": "", "Payload": "", "RestoredPayload": "" } ], "EvaluationTimeInSeconds": 10, "MinimumSecondsBetweenFailureNotifications": 60, "HealthCheckDatabaseConnectionString": "Data Source=Infrastructure\\HealthChecks\\Db\\healthchecksdb" }

Is't possible to use SQLite or other db like MySQL?

Hi,

How come ActionResult / Task< ActionResult > isn't used in this project but instead more direct approaches like Task? Just curious if there is a special reason for it?

Great job with this project! Its saving me a good bit of time and sanity.

However, I am noticing that the DelegatingHandler isn't being called. Which means the authorization process via IdentityServer4 isn't functioning as expected.

See: https://www.dotnetcurry.com/aspnet-mvc/1149/convert-aspnet-webapi2-aspnet5-mvc6

I've noticed that even though SeriLog is used in the projects, the usings are:

using Microsoft.Extensions.Logging;

instead of:

using Serilog

so that stuff like:

_logger = logger?.ForContext()

won't work.

Of course, you can change this in your own code (or the entire code if you want to) but I guess there is a reason for it being as it is?

Main reason for asking this is because we want to add custom Override to serilog like:

  "Override": {
    "Microsoft": "Warning",
    "System": "Warning",
    "System.Net.Http.HttpClient": "Information",
    "OurClassHere": "Debug"

and was not able to figure out how to do it which led us to this.

Thanks.