asp.net-core - 使用 WebAPI .Net Core 进行版本控制无法按预期工作

Question

我正在尝试将 URL 版本控制引入我的 .Net Core WebAPI 应用程序。我还在使用 Swagger 网络工具以方便用户使用。

现在，我对我的代码进行了以下代码更改：

Startup.cs/ConfigureServices 我在下面添加了代码：

services.AddApiVersioning(options => {
                    options.AssumeDefaultVersionWhenUnspecified = true;
                });

现在，在添加任何类型的版本控制之前，我的控制器注释如下所示：

    [Produces("application/json")]
    [Route("api/controllerName")]

并生成一个如下所示的 URL：

http://localhost:12003/swagger/#!/Workspace/GetAll

现在，我在下面添加了注释以启用 api 版本控制：

. [ApiVersion("1.0")] [Produces("application/json")] [Route("api/v{version:apiVersion}/workspace")]

现在当我点击我的招摇用户界面中列出的相同方法时

网址如下所示：

http://localhost:12003/swagger/#!/controllername/ApiV_versionGetAll

虽然我所期待的是：

http://localhost:12003/swagger/#!/controllername/V1.0/GetAll

同样在我大摇大摆的情况下，它现在明确地询问我输入版本号。所以我认为我的问题归结为两个要点：

score 5 · Accepted Answer

您缺少的是支持 API 版本感知 API Explorer 的 API 版本控制的补充包：

Install-Package Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer

API Explorer 是 Swagger 生成器（如 Swashbuckle）完成所有工作的方式。API 版本控制存储库中也提供了源代码和链接。

为了达到你想要的结果，你需要在 URL 中配置 API 版本替换：

services.AddMvcCore().AddVersionedApiExplorer( options => options.SubstituteApiVersionInUrl = true );

注意：AddMvcCore() API Versioning 3.0+ 中不再需要调用

官方 API 版本控制存储库中提供了文档和示例。我建议查看API 文档wiki 主题：

接受的答案扩展了这个包，只要它与您正在使用的 API 版本控制风格保持同步就可以了。API 版本控制始终在每个版本中提供兼容的 API Explorer 扩展。

score 1 · Accepted Answer

使用 swagger 设置 api 版本控制确实是一件棘手的事情，因为它需要正确设置很多部分。

对我们来说幸运的是，有一个很棒的 nuget 包，叫做SwashbuckleAspNetVersioningShim，它很好地解决了这个问题。

添加它

Install-Package SwashbuckleAspNetVersioningShim -Version 2.2.1

2 回答 2