是否可以让 NSwag 忽略控制器?
Is it possible to have NSwag ignore a controller?
我使用 NSwag 为单个控制器生成客户端;我需要它作为自己独立的客户端。我希望将来生成 Swagger 规范时忽略它。
我尝试在控制器顶部添加此属性,但规范中仍注明:
[ApiExplorerSettings(IgnoreApi = true)]
我的控制器正在执行标准 Microsoft.AspNetCore.Mvc.Controller
class。
我认为在最新版本中,
[ApiExplorerSettings(IgnoreApi = true)]
支持。
否则您可以添加 SwaggerIgnoreAttribute
或 OpenApiIgnoreAttribute
属性
[SwaggerIgnore]
[OpenApiIgnore]
或手动select NSwagStudio 或中间件中的控制器...
使用
[OpenApiIgnore]
(因为 [SwaggerIgnore]
已被弃用)
@Arieh 的回答对我有用。
我想分享更多。
- Install package
NSwag.Annotations
for DTO class,对于我在单独项目中的情况,然后使用 [OpenApiIgnore]
修饰应该被忽略的 属性。
- 为 Web 项目安装包
NSwag.AspNetCore
。
我使用 NSwag 为单个控制器生成客户端;我需要它作为自己独立的客户端。我希望将来生成 Swagger 规范时忽略它。
我尝试在控制器顶部添加此属性,但规范中仍注明:
[ApiExplorerSettings(IgnoreApi = true)]
我的控制器正在执行标准 Microsoft.AspNetCore.Mvc.Controller
class。
我认为在最新版本中,
[ApiExplorerSettings(IgnoreApi = true)]
支持。
否则您可以添加 SwaggerIgnoreAttribute
或 OpenApiIgnoreAttribute
属性
[SwaggerIgnore]
[OpenApiIgnore]
或手动select NSwagStudio 或中间件中的控制器...
使用
[OpenApiIgnore]
(因为 [SwaggerIgnore]
已被弃用)
@Arieh 的回答对我有用。 我想分享更多。
- Install package
NSwag.Annotations
for DTO class,对于我在单独项目中的情况,然后使用[OpenApiIgnore]
修饰应该被忽略的 属性。 - 为 Web 项目安装包
NSwag.AspNetCore
。