Question

我有多个Web api项目（微服务），我只想使用一个 swagger-ui 链接公开它们。为了这篇文章的缘故，我将每个Web api项目称为 EndpointA 和 EndpointB 。

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

我的 swagger-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，它们是无效的。

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

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

Answer 1

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

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

另一种解决方案是像这样使用swagger基本路径文档过滤器：

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";
    }
}

如何自定义Swagger端点URL？

1 个答案: