Question

我继承了一个遗留的WebAPI系统，该系统目前在路由模式中使用下划线来表示版本。例如/api/1_0/account，/api/1_1/account等

我正在尝试更新自动生成的文档以使用Swagger，但是使用包含下划线的ApiVersion属性的显式路由会导致异常。例如，这很好用：

[ApiVersion("1")]

然而，这引发了一个例外：

[ApiVersion("1_0")] // < note '_0' here
[RoutePrefix("api/{version:apiVersion}/account")]
public class AccountController : ApiBaseController
{
  // actions...
}

例外是：

FormatException：指定的API版本状态“_1”无效   System.InvalidOperationException：'无法比较数组中的两个元素。'   在System.Collections.Generic.ArraySortHelper`1.Sort（T []键，Int32索引，Int32长度，IComparer`1比较器）
     在System.Array.Sort [T]（T []数组，Int32索引，Int32长度，IComparer`1比较器）
     在System.Collections.Generic.List`1.Sort（Int32索引，Int32计数，IComparer`1比较器）
     在Microsoft.Web.Http.Dispatcher.ApiVersionControllerSelector.InitializeControllerInfoCache（）
     在System.Lazy`1.CreateValue（）
     在System.Lazy`1.LazyInitValue（）
     在System.Lazy`1.get_Value（）
     在Microsoft.Web.Http.Dispatcher.ApiVersionControllerSelector.GetControllerMapping（）
     在System.Web.Http.Routing.AttributeRoutingMapper.AddRouteEntries（SubRouteCollection collector，HttpConfiguration配置，IInlineConstraintResolver constraintResolver，IDirectRouteProvider directRouteProvider）
     在System.Web.Http.Routing.AttributeRoutingMapper。＆lt;＆gt; c__DisplayClass1_1.b__1（）
     在System.Web.Http.Routing.RouteCollectionRoute.EnsureInitialized（Func`1初始化程序）
     在System.Web.Http.Routing.AttributeRoutingMapper。＆lt;＆gt; c__DisplayClass1_0.b__0（HttpConfiguration config）
     在System.Web.Http.HttpConfiguration.EnsureInitialized（）
     在E：\ ProjectPath \ Foo.cs中的ProjectName.Startup.Configuration（IAppBuilder应用程序）：第25行

问题很明显，但如何在版本属性值中包含下划线？这个问题很混乱，因为我假设类的内部（在某些时候）将值解析为整数，但属性本身接受一个字符串......？那为什么会这样呢？

Answer 1

关于为什么这不起作用的一些额外信息。 Microsoft.AspNet.WebApi.Versioning包遵循semantic versioning规则，这些规则要求主要部分和次要部分之间的分隔符为句点。有关此软件包，请参阅rules。

通过一些黑客攻击，可以获得API版本控制包来解析下划线。这是非常基本的代码，可能还没有准备好生产，但是应该给你一个方向。您需要的第一件事是自定义路由约束（基本上剥离the default one）：

public class CustomApiVersionRouteConstraint : IHttpRouteConstraint
{
    public bool Match(HttpRequestMessage request, IHttpRoute route, string parameterName, 
        IDictionary<string, object> values, HttpRouteDirection routeDirection)
    {
        if (string.IsNullOrEmpty(parameterName))
        {
            return false;
        }

        var properties = request.ApiVersionProperties();
        var versionString = "";

        if (values.TryGetValue(parameterName, out object value))
        {
            //This is the real 'magic' here, just replacing the underscore with a period
            versionString = ((string) value).Replace('_', '.');

            properties.RawApiVersion = versionString;
        }
        else
        {
            return false;
        }


        if (ApiVersion.TryParse(versionString, out var requestedVersion))
        {
            properties.ApiVersion = requestedVersion;
            return true;
        }

        return false;
    }
}

确保Web API使用新约束：

var constraintResolver = new DefaultInlineConstraintResolver()
{
    ConstraintMap =
    {
        ["apiVersion"] = typeof( CustomApiVersionRouteConstraint )
    }
};

config.MapHttpAttributeRoutes(constraintResolver);

Answer 2

ApiVersion类有一个ParsePattern，用于定义版本字符串的格式。

const string ParsePattern = @"^(\d{4}-\d{2}-\d{2})?\.?(\d{0,9})\.?(\d{0,9})\.?-?(.*)$";

该模式不允许使用下划线。提供与预期模式不匹配的版本会产生FormatException。

来源：https://github.com/Microsoft/aspnet-api-versioning/blob/master/src/Common/ApiVersion.cs#L25

ASP.NET API Version Format文档提供了更多信息（由@DavidG提供）。

Answer 3

我看到所有答案都集中在标题中的问题......

但你的问题可能出在你的方法上，你提到：

...尝试更新自动生成的文档以使用Swagger，但是使用包含下划线的ApiVersion属性的显式路由会导致异常。

也许简化属性，只使用RoutePrefix，如下所示：

[RoutePrefix("api/1_0/account")]
public class AccountController : ApiController

巴姆，问题解决了...... 剩下的就是在SwaggerConfig中配置MultipleApiVersions，这很简单吗？需要查看示例：MultiApiVersions/Swagger_Test/App_Start/SwaggerConfig.cs

以下是文档的内容：
http://swagger-net-test-multiapiversions.azurewebsites.net/swagger/ui/index

是否可以在控制器的ApiVersion属性中包含下划线？

3 个答案: