ASP.NET核心-大摇大摆-公共和私有大摇大摆页面

Question

[ApiExplorerSettings(GroupName = SwaggerGroups.Public)]

理想情况下，我们将有一个显示所有标记为public的控制器/方法的大摇大摆的页面，以及另一个显示所有endpoint的密码安全endpoint。这可能吗？

Answer 1

首先，您的问题听起来好像没有正确地分离API，实际上应该是两个API（在微服务术语中是两个应用程序服务）。

因此，您也应该将其视为两个独立的API。

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("public", new OpenApiInfo { Title = "My Public API", Version = "v1" });
    c.SwaggerDoc("private", new OpenApiInfo { Title = "My Private API", Version = "v1" });
});

这将生成两个不同的OpenAPI（Swagger）规范。/api-docs/public/swagger.json和/api-docs/private/swagger.json，它们可以托管在两个不同的UI应用程序中（一个受保护，另一个公开可用）

// Public Docs Api
app.UseSwaggerUI(c =>
{
    // we use absolute uri here, since the swagger.json is outside of this application
    c.SwaggerEndpoint("http://example.com/api-docs/public/swagger.json", "Public API");
});


// Private Docs App
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("http://example.com/api-docs/private/swagger.json", "Private API");
});

另一种方法是使用构建管道/持续集成系统。aspnetcore在5.x版本的库中提供了一个cli扩展，它可以作为构建脚本的一部分执行，以便在构建过程中生成swagger.json文件。

例如

dotnet swagger tofile --output ../swagger/myapi/private.json MyCompany.MyApplication.Mvc private
dotnet swagger tofile --output ../swagger/myapi/public.json MyCompany.MyApplication.Mvc public

并且有一个像这样的文档应用程序

// Private Docs App
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("http://example.com/api-docs/swagger/myapp/private.json", "Private API");
    c.SwaggerEndpoint("http://example.com/api-docs/swagger/myapp/public.json", "Public API");
});