【发布时间】:2020-07-14 07:24:49
【问题描述】:
我们通过 Swagger 在我们的项目中使用 Web API 2。我的问题是当 Microsoft.AspNet.WebApi.Versioning 应用如下:
Swagger UI 忽略了这样一个事实,即现在我的 API 中有需要提供的版本。
我查看了几个示例,但似乎没有一个能以令人满意的方式解决这个问题。
如何强制 Swagger 让我添加 API 版本或仅将版本号自动添加到 URL?
到目前为止的 Swagger 配置:
GlobalConfiguration.Configuration
.EnableSwagger(c =>
{
c.SingleApiVersion("v1", "MoovShack.ServerApi");
// If your API has multiple versions, use "MultipleApiVersions" instead of "SingleApiVersion".
// In this case, you must provide a lambda that tells Swashbuckle which actions should be
// included in the docs for a given API version. Like "SingleApiVersion", each call to "Version"
// returns an "Info" builder so you can provide additional metadata per API version.
//
//c.MultipleApiVersions(
// (apiDesc, targetApiVersion) => ResolveVersionSupportByRouteConstraint(apiDesc, targetApiVersion),
// (vc) =>
// {
// vc.Version("v2", "Swashbuckle Dummy API V2");
// vc.Version("v1", "Swashbuckle Dummy API V1");
// });
c.OperationFilter<MoovShackTokenHeaderParameter>();
})
.EnableSwaggerUi(c =>
{
// If your API has multiple versions and you've applied the MultipleApiVersions setting
// as described above, you can also enable a select box in the swagger-ui, that displays
// a discovery URL for each version. This provides a convenient way for users to browse documentation
// for different API versions.
//
//c.EnableDiscoveryUrlSelector();
});
到目前为止,您可以看到 MultipleApiVersions 被禁用 - 一个很好的原因是它不会产生任何结果。特别是因为我不确定“ResolveVersionSupportByRouteConstraint”应该做什么。
我还读到“EnableDiscoveryUrlSelector”会产生某种影响,但我也不确定这是否适用于我的情况。当我启用它时,什么也没发生。
【问题讨论】:
标签: c# asp.net-web-api swagger swagger-ui