有没有办法在ASP.Net Web API中对响应模型属性进行别名

时间:2013-01-12 23:18:07

标签: asp.net-web-api

如果要使用JSON样式小写名称从Web Api中的操作方法返回对象,是否有办法对属性名称进行别名,以便下面的C#对象看起来像后面的JSON对象。

C#响应模型

    public class Account
    {
        public int Id { get; set; }
        public string AccountName { get; set; }
        public decimal AccountBalance { get; set; }

    }

我想退回的JSON

    {
        "id" : 12,
        "account-name" : "Primary Checking",
        "account-balance" : 1000
    }

2 个答案:

答案 0 :(得分:46)

您可以使用JSON.NET的JsonProperty

 public class Account
    {
        [JsonProperty(PropertyName="id")]
        public int Id { get; set; }
        [JsonProperty(PropertyName="account-name")]
        public string AccountName { get; set; }
        [JsonProperty(PropertyName="account-balance")]
        public decimal AccountBalance { get; set; }   
    }

这只适用于JSON.NET - 显然。如果你想更加不可知,并且让这种类型的命名能够用于其他可能的格式化程序(即你将JSON.NET改为其他东西,或者用于XML序列化),请参考System.Runtime.Serialization并使用:< / p>

 [DataContract]
 public class Account
    {
        [DataMember(Name="id")]
        public int Id { get; set; }
        [DataMember(Name="account-name")]
        public string AccountName { get; set; }
        [DataMember(Name="account-balance")]
        public decimal AccountBalance { get; set; }   
    }

答案 1 :(得分:19)

如果您需要对序列化进行精细控制,那么Filip上面的答案非常好,但如果您想进行全局更改,可以使用如下所示的单线程进行。

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

        config.Formatters.JsonFormatter.SerializerSettings.Converters.Add(new StringEnumConverter());
        config.Formatters.JsonFormatter.SerializerSettings.ContractResolver =
            new CamelCasePropertyNamesContractResolver();  // This line will cause camel casing to happen by default.
    }
}

http://www.asp.net/web-api/overview/formats-and-model-binding/json-and-xml-serialization#json_camelcasing

修改 根据以下评论,我继续在这里添加了一篇博文,其中包含完整的解决方案:http://www.ryanvice.net/uncategorized/extending-json-net-to-serialize-json-properties-using-a-format-that-is-delimited-by-dashes-and-all-lower-case/