是否可以让 NSwag 忽略控制器？

Question

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 1

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...

Answer 2

Use [OpenApiIgnore]

(since [SwaggerIgnore] has been deprecated)

Answer 3

@Arieh 's answer worked for me. I'd like to share more.

1. Install package NSwag.Annotations for DTO class, for my case which is in separated project, then use [OpenApiIgnore] decorate the property which should be ignored.
2. Install package NSwag.AspNetCore for the web project.