Swagger UI - 使用Microsoft.AspNet.WebApi.Versioning时的Web API版本控制

问题描述 投票:0回答:1

我们在Swagger项目中使用Web API 2。我的问题是当Microsoft.AspNet.WebApi.Versioning应用如下:

enter image description here

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
1个回答
1
投票

我们在项目中使用它,并且swagger认出它并且它看起来很好

[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)
© www.soinside.com 2019 - 2024. All rights reserved.