如何更改api输出的根元素

时间:2016-10-16 14:06:55

标签: c# asp.net asp.net-web-api sitemap

我创建了一个api,它以xml的形式提供输出。它用于为网站提供站点地图。它只包含以下代码

public class SitemapApiController : ApiController
{
    public urlset GetSitemap()
    {
        // code for data access etc
        return urlsetObj;
    }
}

urlset类非常简单

[XmlRoot("urlset")]
public class urlset: List<url>
{
}

url类如下

public class url
{

    public string loc { get; set; }
    public DateTime lastmod { get; set; }        
    public double priority { get; set; }
}

现在我的问题是输出是

<arrayofurls>
         <url>.....

虽然我希望它是

<urlset>
     <url>....

我已经为此阅读了类似的帖子,但没有解脱。如Modify the xml array element name in serialized ASP.NET WebAPI object帖子中所述,如果我使用

[XmlArray("urlset")]

api控制器上的属性,然后它给出了属性&#34; XmlArray&#34;在此声明类型中无效。请帮助我,以便我可以从api返回有效的站点地图。

修改
根据这个输出仍然有点不同。现在显示

<urlset>
    <url>
        <url>
            <loc>
        <url>........ 

有一个额外的不必要的url属性作为所有url属性的父级。

1 个答案:

答案 0 :(得分:2)

<强>已更新

花了一点点工作,但我相信我找到了你想要的东西。

WebApi项目应使用命名空间System.Runtime.Serialization序列化XML,而不是命名空间System.Xml.Serialization

使用这种新的序列化方法,可以非常简单地输出结果。

api控制器GET方法:

public urlset Get()
{
    return new urlset
    {
        new url { loc = "1" },
        new url { loc = "2" },
        new url { loc = "3" }
    };
}

urlset类:

[CollectionDataContract(Name ="urlset", Namespace ="")]
public class urlset:List<url>
{
}

url类:

[DataContract(Namespace = "")]
public class url
{
    [DataMember]
    public string loc { get; set; }
    [DataMember]
    public DateTime lastmod { get; set; }
    [DataMember]
    public double priority { get; set; }
}

输出:

<urlset xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
    <url>
        <lastmod>2016-10-19T08:07:28.6867397-07:00</lastmod>
        <loc>1</loc>
        <priority>0</priority>
    </url>
    <url>
        <lastmod>2016-10-15T08:07:28.6867397-07:00</lastmod>
        <loc>2</loc>
        <priority>0</priority>
    </url>
    <url>
        <lastmod>2016-09-20T08:07:28.6867397-07:00</lastmod>
        <loc>3</loc>
        <priority>0</priority>
    </url>
</urlset>

我意识到您在问题中提供的示例在根节点中没有xmlns属性。但是,似乎没有“简单”的方法来删除它。

以下是我用于解决此问题的资源:

StackOverflow: How to serialize xml into desired format in asp.net web api

MSDN: Collection Types in Data Contracts