我正在开发一个带有 Web API 项目的 Asp.Net core 3.1 MVC Web 应用程序。现在我只想为 API 项目配置 Swagger 文档,那么如何在配置中指定仅将 Web API 控制器用于文档?
在 ConfigureServices 方法中的启动类中对 swagger 的配置如下:-
services.AddSwaggerGen(option =>
{
option.SwaggerDoc("v1.0",
new OpenApiInfo
{
Title = "ProjName OpenApi",
Version = "1.0",
//Description = //get from appsettings.json
});
var xmlCommentFileName = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
var xmlCommentFilePath = Path.Combine(AppContext.BaseDirectory, xmlCommentFileName);
option.IncludeXmlComments(xmlCommentFilePath);
});
Configure 方法中的配置如下:-
app.UseSwagger(option =>
{
option.RouteTemplate = "docs/{documentname}/swagger.json";
});
app.UseSwaggerUI(option =>
{
option.SwaggerEndpoint("/docs/v1.0/swagger.json", "ProjName OpenApi v1.0");
option.RoutePrefix = "docs/v1.0";
option.DocumentTitle = "ProjName OpenAPI Docs";
});
问题是 swagger gen 正在查看控制器文件夹、管理和身份区域以生成文档,但我宁愿将其配置为仅使用 WebApi 文件夹中的控制器。在这些控制器中指定了路由属性的所有控制器或操作方法也会在 API 文档中列出。我怎样才能排除那些?
有人可以帮我解决这个问题吗?我真的被困在这里了。
PS:我想提一下,我不能将 API 层移到其单独的项目中。