展开C#对象以覆盖XML文档中的属性名称

时间:2018-11-08 18:17:49

标签: c# xml api documentation

我目前正在构建和终结点(可称其为myendpoint),并且希望能够操纵参数名称以符合要求。假设我有一个名为myobject的对象,它包含以下属性nameaddressaddressCityaddressState。但是,我需要addressCityaddressState才能在文档中显示为address-cityaddress-state。有没有一种方法可以覆盖对象内部的属性名称来实现此目的?

public class myobject
{
    public string name { get; set; }

    public string address { get; set; }

    [JsonProperty("address-city")]
    public string addressCity { get; set; }

    [JsonProperty("address-state")]
    public string addressState { get; set; }
}

/// <summary>
/// Gets some information
/// </summary>
/// <param name="myobject"></param>
/// <returns></returns>
public IHttpActionResult GetInformation([FromURI] Object myobject)
{
   // Code
}

帮助页面上的当前文档显示为: http://localhost:9999/api/myendpoint?name= {name}&address = {address}&addressCity = {addressCity}&addressState = {addressState}

我希望它显示为: http://localhost:9999/api/myendpoint?name= {name}&address = {address}&address-city = {address-city}&address-state = {address-state}

我尝试使用多个属性,例如DisplayNameJsonProperty(当前使用此属性,但是XML文档未使用新名称)。

编辑:新增功能

0 个答案:

没有答案