如何自定义 Swagger 终结点 URL

Question

我有多个 Web API 项目(微服务(，我想只使用一个 swagger-ui 链接来公开它们。为了这篇文章，我将每个 Web api 项目称为终结点 A 和终结点 B。

我创建了一个 swagger-ui 项目，并将每个终结点添加到此项目中。

我的招摇UI项目Startup.cs

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseSwaggerUI(c => {
        c.SwaggerEndpoint("/EndpointA/swagger/v1/swagger.json", "EndpointA");
        c.SwaggerEndpoint("/EndpointB/swagger/v1/swagger.json", "EndpointB");
    });
}

我的端点 A/B Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new Info
        {
            Version = "v1",
            Title = "EndpointA", // or "EndpointB",
        });
    });
}

---

我的问题是每个swagger.json文件都不包含端点前缀。路径不是/EndpointA/Controller/Action，而是/Controller/Action，这是无效的。

---

我试图在我的 swagger ui 项目中设置一个自定义 url 前缀，就像这个c.RoutePrefix = "EndpointA";.它适用于我的端点 A，但我只能为所有端点设置一个，因此端点 B 不起作用。

我还尝试使用 SwaggerGen 直接在每个端点中设置前缀，但我不知道如何/是否可能。

Answer 1

我最终使用 UsePathBaseExtensions.UsePathBase(IApplicationBuilder, PathString) 方法注册了我的 API 的基本路径。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UsePathBase(new PathString("/EndpointA"));
    app.UseMvc();
}

---

另一种解决方案是使用招摇的基本路径文档过滤器，如下所示：

public void ConfigureServices(IServiceCollection services)
{
     services.AddSwaggerGen(c =>
     {
         c.DocumentFilter<BasePathFilter>();
     });
 }

和过滤器：

public class BasePathFilter: IDocumentFilter
{
    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
    {
        swaggerDoc.BasePath = "/EndpointA";
    }
}