- html - 出于某种原因,IE8 对我的 Sass 文件中继承的 html5 CSS 不友好?
- JMeter 在响应断言中使用 span 标签的问题
- html - 在 :hover and :active? 上具有不同效果的 CSS 动画
- html - 相对于居中的 html 内容固定的 CSS 重复背景?
我正在 ASP.NET Core 中构建一个 Web API,并且正在试验多个版本。我正在按照以下说明为每个版本创建 Swagger 文档:https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/master/README.md#customize-the-action-selection-process
我有两个版本的相同 Action ,定义如下:
namespace Web.Api
{
[ApiController]
[Area("api")]
[Route("[area]/[controller]")]
public abstract class MyApiControllerBase : ControllerBase
{
}
}
namespace Web.Api.V1
{
public class TestController : MyApiControllerBase
{
[HttpGet]
[ApiVersion("1.0")]
public IActionResult Get()
{
return Ok("Version 1.0 endpoint.");
}
}
}
namespace Web.Api.V2
{
public class TestController : MyApiControllerBase
{
[HttpGet]
[ApiVersion("2.0")]
public IActionResult Get()
{
return Ok("Version 2.0 endpoint.");
}
}
}
Startup.cs
中是这样配置的:
services.AddSwaggerGen(options =>
{
options.DocInclusionPredicate((docName, apiDesc) =>
{
if (!apiDesc.TryGetMethodInfo(out MethodInfo methodInfo))
{
return false;
}
IEnumerable<ApiVersion> versions = methodInfo.DeclaringType
.GetCustomAttributes(true)
.OfType<ApiVersionAttribute>()
.SelectMany(a => a.Versions);
return versions.Any(v => $"v{v.ToString()}" == docName);
});
options.SwaggerDoc("v1.0", new OpenApiInfo { Title = "My API", Version = "v1.0" });
options.SwaggerDoc("v2.0", new OpenApiInfo { Title = "My API", Version = "v2.0" });
});
DocInclusionPredicate
加载 Swagger 文档时,似乎
ApiVersion
属性没有被选取,因此解释了为什么它们没有包含在文档中。例如,当
Web.Api.V2.TestController.Get
被传递为
apiDesc
参数,这是为 Attributes 找到的内容:
ApiControllerAttribute
,
AreaAttribute
,
RouteAttribute
, 和
ControllerAttribute
被发现。所有这些都是基类上的属性,而不是直接在
TestController
上的。或
Get()
行动本身。
最佳答案
对于asp.net core 3.0,您可以按照以下步骤操作:
1.安装 Swashbuckle.AspNetCore 5.0.0
2.安装 Microsoft.AspNetCore.Mvc.Versioning 4.0.0
3.安装 Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer 4.0.0
4.改变你的 Controller 如下(ApiVersion
需要在 Controller 上声明):
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("1.0")]
public class TestController : MyApiControllerBase
{
[HttpGet]
public IActionResult Get()
{
return Ok("Version 1.0 endpoint.");
}
}
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("2.0")]
public class TestController : MyApiControllerBase
{
[HttpGet]
public IActionResult Get()
{
return Ok("Version 2.0 endpoint.");
}
}
services.AddVersionedApiExplorer
并设置
options.SubstituteApiVersionInUrl=true
来告诉swagger替换 Controller 路由中的版本并配置api版本:):
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddApiVersioning(o => {
o.ReportApiVersions = true;
o.AssumeDefaultVersionWhenUnspecified = true;
o.DefaultApiVersion = new ApiVersion(1, 0);
});
services.AddVersionedApiExplorer(o =>
{
o.GroupNameFormat = "'v'VVV";
o.SubstituteApiVersionInUrl = true;
});
services.AddSwaggerGen(options =>
{
options.DocInclusionPredicate((docName, apiDesc) =>
{
if (!apiDesc.TryGetMethodInfo(out MethodInfo methodInfo))
{
return false;
}
IEnumerable<ApiVersion> versions = methodInfo.DeclaringType
.GetCustomAttributes(true)
.OfType<ApiVersionAttribute>()
.SelectMany(a => a.Versions);
return versions.Any(v => $"v{v.ToString()}" == docName);
});
options.SwaggerDoc("v1.0", new OpenApiInfo { Title = "My API", Version = "v1.0" });
options.SwaggerDoc("v2.0", new OpenApiInfo { Title = "My API", Version = "v2.0" });
});
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseHttpsRedirection();
app.UseApiVersioning();
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1.0/swagger.json", "V1 Docs");
c.SwaggerEndpoint("/swagger/v2.0/swagger.json", "V2 Docs");
});
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}
关于c# - Swagger 找不到 ApiVersion ed 的操作,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/60084877/
我正在尝试在 Windows 上运行的小于 1GB 的 VM 上设置 YouTrack 和 TeamCity。使用率将非常低(用户和请求)。这是一个 POC 环境,如果它有效,我可能会将它推送到一个超
所以我在尝试使用 FORFILES 解决这个问题时遇到了麻烦。我正在尝试获取不超过 4 天的文件。所以基本上少于 4 天。然而,这似乎不太可能,因为/d -4 获取所有 4 天或更早的项目。 以下是我
如何从下面的 events 表中选择小于 15 分钟前创建的 events? CREATE TABLE events ( created_at timestamp NOT NULL DEFAU
Google Analytics Realtime提供 rt:minutesAgo ,可以过滤查询。 然而,它是一个维度而不是一个度量标准,<=不能在过滤器中使用。 假设我想在最后 n 分钟内获得一些
iOS 核心数据 - 严重的应用程序错误 - 尝试插入 nil 你好, 我的应用程序实际上运行稳定,但在极少数情况下它会崩溃并显示此错误消息... 2019-04-02 20:48:52.437172
我想制作一个 html div 以快速向右移动(例如不到 1 秒)并消失。然后1秒后再次直接出现在这个过程最开始div的位置。此过程将由单击按钮并重复 10 次触发。 我试图在 CSS 中使用过渡属性
我发现使用 TimeTrigger 是 Windows 10 (UWP) 上计划后台任务的方式。但是看起来我们需要给出的最小数字是 15 分钟。只是想知道,即使我们安排它在接下来的 1 分钟内运行,警
我必须在 1 秒内在屏幕上打印 2^20 行整数 printf 不够快,还有其他易于使用的快速输出替代方法吗? 每一行只包含 1 个整数。 我要求它用于竞争性编程问题,我必须将其源代码提交给法官。 最
我是一名优秀的程序员,十分优秀!