Question

我正在为一个新的web api项目做一些工作，我的方法/参数遵循标准的c＃命名格式;方法名称为PascalCase，参数为camelCase。

不幸的是，我刚刚发现客户端的文档已经发布，所有参数都是ruby / php样式，带有snake_case类型参数名称。

返回对象和POST对象很容易转换;我使用crallen's code版本来替换默认的Json输入/输出，但是在GET请求中，似乎没有这么简单的答案。

我希望保持命名惯例不变。有没有办法让绑定器自动将my_parameter更改为myParameter以获取所有请求？我是否必须构建完全不同的活页夹？

例如，如果我将此作为方法签名：

[Route("~/api/Widgets")]
[ResponseType(typeof(Widget))]
public async Task<HttpResponseMessage> GetWidget(int widgetId, int groupId)
{
    . . .

我希望能够在网址

中使用它

https://myserver.com/api/Widgets?widget_id=12345&group_id=54321

我是否必须重新发明轮子才能使其工作？我已经看到了替换特定类型模型绑定器的示例，但在此级别没有任何内容。我最好只是在代码中更改参数名称吗？

Answer 1

您可以使用重写ApiControllerActionSelector的自定义Request.RequestUri然后调用基本选择器来实现此目的。

这就是：

首先，创建自定义选择器：

public class SnakeCaseActionSelector : ApiControllerActionSelector
{
    public override HttpActionDescriptor SelectAction(HttpControllerContext controllerContext)
    {
        var newUri = CreateNewUri(
            controllerContext.Request.RequestUri, 
            controllerContext.Request.GetQueryNameValuePairs());

        controllerContext.Request.RequestUri = newUri;

        return base.SelectAction(controllerContext);
    }

    private Uri CreateNewUri(Uri requestUri, IEnumerable<KeyValuePair<string, string>> queryPairs)
    {
        var currentQuery = requestUri.Query;
        var newQuery = ConvertQueryToCamelCase(queryPairs);
        return new Uri(requestUri.ToString().Replace(currentQuery, newQuery));
    }

    private static string ConvertQueryToCamelCase(IEnumerable<KeyValuePair<string, string>> queryPairs)
    {
        queryPairs = queryPairs
            .Select(x => new KeyValuePair<string, string>(x.Key.ToCamelCase(), x.Value));

        return "?" + queryPairs
            .Select(x => String.Format("{0}={1}", x.Key, x.Value))
            .Aggregate((x, y) => x + "&" + y);
    }
}

接下来，创建一些扩展名以转换为驼峰大小写并转换为大写单词：

public static class StringExtensions
{
    public static string ToCamelCase(this string source)
    {
        var parts = source
            .Split(new[] { '_' }, StringSplitOptions.RemoveEmptyEntries);

        return parts
            .First().ToLower() +
            String.Join("", parts.Skip(1).Select(ToCapital));
    }

    public static string ToCapital(this string source)
    {
        return String.Format("{0}{1}", char.ToUpper(source[0]), source.Substring(1).ToLower());
    }
}

最后将动作选择器添加到WebApiConfig：

config.Services.Replace(typeof(IHttpActionSelector), new SnakeCaseActionSelector());

Answer 2

我想使用自定义价值提供商工厂提出替代解决方案：

从QueryStringValueProviderFactory导出并覆盖GetValueProvider
抓取查询字符串对并相应地修改它们。
返回NameValuePairsValueProvider的实例，接受新修改的值。

将QueryStringValueProviderFactory中的原始HttpConfiguration.Services替换为您自己的。{/ li>

粗略地翻译成：

public class SnakeQueryStringValueProviderFactory : QueryStringValueProviderFactory
{
    public override IValueProvider GetValueProvider( HttpActionContext actionContext )
    {
        var pairs = actionContext.ControllerContext.Request.GetQueryNameValuePairs();

        // modify query string keys accordingly
        // e.g. remove '_' from query string keys 
        // var newPairs = ...

        return new NameValuePairsValueProvider( newPairs, CultureInfo.InvariantCulture );
    }
}

以下内容应该有所改进，但你明白了。

config.Services.Remove( 
    typeof( ValueProviderFactory ),
    config.Services.GetValueProviderFactories().First( f => f is QueryStringValueProviderFactory ) 
);
config.Services.Insert( typeof( ValueProviderFactory ), 0, new SnakeQueryStringValueProviderFactory() ); // should be first

Answer 3

venerik，我认为你的CreateNewUri方法可以通过使用UriBuilder类而不是直接替换字符串来改进。这意味着您不必将查询字符串与“？”连接起来。在您的ConvertQueryToCamelCase方法中。当尝试替换包含空格，冒号，百分比等编码符号的URL中的查询字符串时，它将解决此问题。

private Uri CreateNewUri(Uri requestUri, IEnumerable<KeyValuePair<string, string>> queryPairs)
{
    var currentQuery = requestUri.Query;
    var newQuery = ConvertQueryToCamelCase(queryPairs);
    var builder = new UriBuilder(requestUri) 
    {
        Query = newQuery;
    };
    return builder.Uri;
}

private static string ConvertQueryToCamelCase(IEnumerable<KeyValuePair<string, string>> queryPairs)
{
    queryPairs = queryPairs
        .Select(x => new KeyValuePair<string, string>(x.Key.ToCamelCase(), x.Value));

    return queryPairs
        .Select(x => String.Format("{0}={1}", x.Key, x.Value))
        .Aggregate((x, y) => x + "&" + y);
}

Web Api参数绑定：snake_case到camelCase

3 个答案: