Nswag: Option to include the aspnet core healthcheck apis into the swagger?
Microsoft offered the possibility to have Healthcheck endpoints directly in the startup > https://docs.microsoft.com/de-de/aspnet/core/host-and-deploy/health-checks?view=aspnetcore-2.2
If we want to include this Healthcheck APIs in the generated swagger is there a way with NSwag to achieve this?
MarcoK80
All 7 comments
If they are exposed by the aspnetcore api explorer then you should just see them, otherwise it would require some manual code, eg an additional document processor which looks them up and adds them as new operations
RicoSuter
on 11 Apr 2019
Tested with NSWag Studio and ASP.NET Core via API Explorer and it seems the healthcheck routes defined in the startup are not exposed via aspnetcore api explorer.
MarcoK80
on 11 Apr 2019
So this is always only a single operation with a simple route (eg /health) and GET?
RicoSuter
on 11 Apr 2019
Yes correct. We try to get this manual in. Seems more an issue for Microsoft to have these kind of APIs available in the api explorer.
MarcoK80
on 12 Apr 2019
Not sure if it makes sense to include that for all users - not everyone might want this to end up in the spec. Should probably opt-in via explorer settings. /cc @pranavkm any plans to do this?
RicoSuter
on 12 Apr 2019
@rynowak \ glencc, what do you guys think? The current contract with Swagger generator is integrated with MVC, we may have to come up with something different if we want to consider this.
pranavkm
on 26 Apr 2019
We have no plans to do this in ASP.NET Core 3.0. This is possible for someone else to provide with extensibility, either:
- by integrating the global endpoint collection directly with NSwag/Swashbuckle through their extensiblity
- by implementing an
IApiDescriptionProvider
Endpoint Routing (ASP.NET Core 3.0+) is a good foundation to build OpenAPI on top of, it's much more information/metadata rich than middleware. I want the community to have an OpenAPI story that's endpoint-centric eventually, but it's not clear what work that requires from us and when we would slot that in. We're much more focused now on getting users of MVC onto the new routing system as a primary concern.
I would be really interested to see what it would look like for a framework like NSwag or Swashbuckle to integrate directly with the endpoint collection.
rynowak
on 26 Apr 2019
Related issues
Peter554
路
3Comments
Maleki
路
4Comments
rh78
路
3Comments
BlackGad
路
4Comments
AnthonySteele
路
3Comments
Most helpful comment
We have no plans to do this in ASP.NET Core 3.0. This is possible for someone else to provide with extensibility, either:
IApiDescriptionProviderEndpoint Routing (ASP.NET Core 3.0+) is a good foundation to build OpenAPI on top of, it's much more information/metadata rich than middleware. I want the community to have an OpenAPI story that's endpoint-centric eventually, but it's not clear what work that requires from us and when we would slot that in. We're much more focused now on getting users of MVC onto the new routing system as a primary concern.
I would be really interested to see what it would look like for a framework like NSwag or Swashbuckle to integrate directly with the endpoint collection.