首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >问答首页 >使用Microsoft.AspNet.WebApi.Versioning时的Swagger版本控制

使用Microsoft.AspNet.WebApi.Versioning时的Swagger版本控制
EN

Stack Overflow用户
提问于 2017-11-09 14:23:27
回答 1查看 9.9K关注 0票数 1

我们在使用Swagger的项目上使用Web 2。我的问题是,当应用Microsoft.AspNet.WebApi.Versioning时,如下所示:

Swagger UI忽略了一个事实,即现在我的API中有需要提供的版本。

我看了几个例子,但似乎没有一个能令人满意地解决这个问题。

如何强制Swagger允许我添加API版本,或者只是自动将版本号添加到URL中?

到目前为止的摇摆配置:

代码语言:javascript
运行
复制
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“有某种影响,但我也不确定这是否适用于我的情况。当我启用它时,什么都没发生。

EN

回答 1

Stack Overflow用户

回答已采纳

发布于 2018-09-05 12:00:19

我们在我们的项目中像这样使用它,swagger识别它,它看起来很好。

代码语言:javascript
运行
复制
[ApiVersion( "1.0" )]
[Route("api/v{version:apiVersion}/[controller]")]  
public class SomeControlelr: Controller{
    [HttpGet("", Name = "Someaction"), MapToApiVersion("1.0")]
    public async Task<IActionResult> SomeAction(string someParameter)
票数 5
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/47204257

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档