Is it possible to have NSwag ignore a controller?

c# swagger nswag
James B. Nall picture James B. Nall · Apr 18, 2017 · Viewed 7.7k times · Source

I used NSwag to generate a client for a single controller; I needed it as its own separate client. I would like for it to be ignored when the Swagger specification is generated in the future.

I tried adding this attribute at the top of the controller but it is still being noted in the specification: [ApiExplorerSettings(IgnoreApi = true)]

My controller is implementing the standard Microsoft.AspNetCore.Mvc.Controller class.

Answer

Rico Suter picture Rico Suter · Apr 18, 2017

I think in the latest version,

[ApiExplorerSettings(IgnoreApi = true)]

is supported.

Otherwise you can add the SwaggerIgnoreAttribute OR OpenApiIgnoreAttribute attribute

[SwaggerIgnore]
[OpenApiIgnore]

Or manually select the controllers in NSwagStudio or in the middleware...

Related questions

ASP.NET Core - Swashbuckle not creating swagger.json file

I am having trouble getting the Swashbuckle.AspNetCore (1.0.0) package to generate any output. I read the swagger.json file should be written to '~/swagger/docs/v1'. However, I am not getting any output. I started with a brand …

Read More
How to omit methods from Swagger documentation on WebAPI using Swashbuckle

I have a C# ASP.NET WebAPI application with API documentation being automatically generated using Swashbuckle. I want to be able to omit certain methods from the documentation but I can't seem to work out how to tell Swagger not …

Read More
Swashbuckle/Swagger + ASP.Net Core: "Failed to load API definition"

I develop an ASP.NET Core 2 application and included Swagger. Everything worked fine until I introduced a method without explicitly defining the HTTP action: public class ErrorController : Controller { [Route("/error")] public IActionResult Index() { return StatusCode(500, new Error("Internal error.")); } } When …

Read More