在 .Net Core 中使用 Swagger 在 API 方法中设置自定义路径前缀

Question

我想在 .Net Core API 方法中使用 swagger 添加我的自定义路径前缀。

例如，我的 API 方法是这样声明的：

[Route("api/v1/Customer")]
[HttpGet]
public async Task<IActionResult> Customer()
{
        // some implementation
        return Ok();
}

所以目前，如果我使用 http://localhost:50523/api/v1/Customer 调用 API，它可以正常工作。

现在，我想添加一些自定义路径前缀。例如。 /some/custom/path/ 在实际 API 方法路径之前。这意味着——如果我使用 http://localhost:50523/some/custom/path/api/v1/Customer 调用 API，它应该可以工作。

我想在 .Net 核心中使用 Swagger 来实现这一点，并且我不想更改操作方法级别的 API 路径，因为我已经编写了数百个 API 方法并且我不想更改每个操作方法的 URL。

任何帮助将不胜感激。

Answer 1

在 .Net 5.0 中

public class PathPrefixInsertDocumentFilter : IDocumentFilter
{
    private readonly string _pathPrefix;

    public PathPrefixInsertDocumentFilter(string prefix)
    {
        this._pathPrefix = prefix;
    }

    public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
    {
        var paths = swaggerDoc.Paths.Keys.ToList();
        foreach (var path in paths)
        {
            var pathToChange = swaggerDoc.Paths[path];
            swaggerDoc.Paths.Remove(path);
            swaggerDoc.Paths.Add($"{_pathPrefix}{path}", pathToChange);
        }
    }
}

应用过滤器

services.AddSwaggerGen(options =>
{
    options.SwaggerDoc("v1", new Info {Title = "MyApp", Version = "v1"});

    ...  other setup

    options.DocumentFilter<PathPrefixInsertDocumentFilter>("api");
});

Answer 2

如果添加 DocumentFilter，则可以将前缀添加到要更改的所有路径。

public class PathPrefixInsertDocumentFilter : IDocumentFilter
{
    private readonly string _pathPrefix;

    public PathPrefixInsertDocumentFilter(string prefix)
    {
        this._pathPrefix = prefix;
    }

    public void Apply(SwaggerDocument swaggerDoc, DocumentFilterContext context)
    {
        var paths = swaggerDoc.Paths.Keys.ToList();
        foreach (var path in paths)
        {
            var pathToChange = swaggerDoc.Paths[path];
            swaggerDoc.Paths.Remove(path);
            swaggerDoc.Paths.Add(new KeyValuePair<string, PathItem>("/" + _pathPrefix + path, pathToChange));
        }
    }
}

然后，您在 swagger 设置中添加过滤器：

        services.AddSwaggerGen(options =>
        {
            options.SwaggerDoc("v1", new Info {Title = "MyApp", Version = "v1"});

            ...  other setup

            options.DocumentFilter<PathPrefixInsertDocumentFilter>("api");
        });

这不会改变您的 API - 我们在生产环境中使用它来处理反向代理，我们使用前缀将请求路由到适当的容器，但将其剥离。

Answer 3

也许您可以在 Controller 类中使用 Route 属性，例如： [Route("/some/custom/path/")] public class CustomerController { [Route("api/v1/Customer")] [HttpGet] public async Task<IActionResult> Customer() { // some implementation return Ok(); } }

希望对你有用

Answer 4

您可以在您的 api 控制器顶部使用 [Route("prefix/[controller]")]

[Route("prefix/[controller]")]
public class MyController : ControllerBase
{
  [Route("api/v1/Customer")]
  [HttpGet]
   public async Task<IActionResult> Customer()
   {
    // some implementation
    return Ok();
    }
}