practical-api-guidelines icon indicating copy to clipboard operation
practical-api-guidelines copied to clipboard

Health check middleware

Open MassimoC opened this issue 7 years ago • 5 comments

consider to use the health check middleware (ASPNET core 2.2) https://docs.microsoft.com/en-us/aspnet/core/host-and-deploy/health-checks?view=aspnetcore-2.2

MassimoC avatar Jan 23 '19 17:01 MassimoC

The idea of this is great but the implementation is not there yet imo.

For example it has no support for OpenAPI so it will not work with gateways

tomkerkhove avatar Jan 23 '19 20:01 tomkerkhove

Actually in the first simple implementation I've explicitly excluded the Health check controller from the Open API generation ([ApiExplorerSettings(IgnoreApi = true)]) I thought was better to hide all those technical operations ... I don't have a clear opinion on this.

MassimoC avatar Jan 25 '19 16:01 MassimoC

My vision on this is that it should be include to improve discovery. Restricted access is up to the gateway or app

But it's up to you

tomkerkhove avatar Jan 25 '19 16:01 tomkerkhove

Add this as guidance on the maturity level2

MassimoC avatar Mar 18 '19 10:03 MassimoC

I can pick this up if you want

tomkerkhove avatar Oct 08 '19 11:10 tomkerkhove