使用返回 XML 的 Recurly Rest API 时出现 WebAPI 序列化问题 [英] WebAPI Serialization problems when consuming Recurly Rest API which returns XML

问题描述

我是 ASP.Net Web API 的新手.我正在尝试与基于 Recurly REST 的 API 进行交互，但在 ReadAsAsync 调用期间出现如下错误，我认为这是我认为它尝试序列化响应的关键.

I'm new to the ASP.Net Web API. I'm trying to interact with the Recurly REST based API and I am getting errors like below during my ReadAsAsync call which is the point I believe it attempts to serialize the response.

{"Error in line 1 position 73. Expecting element 'account' from namespace 'http://schemas.datacontract.org/2004/07/RecurlyWebApi.Recurly'.. Encountered 'Element'  with name 'account', namespace ''. "}

这是我的 HttpClient 实现，为简洁起见进行了简化:

Here is my HttpClient implementation, simplified for brevity:

  public class RecurlyClient
  {
    readonly HttpClient client = new HttpClient();

    public RecurlyClient()
    {
      var config = (RecurlySection)ConfigurationManager.GetSection("recurly");

      client.BaseAddress = new Uri(string.Format("https://{0}.recurly.com/v2/", config.Subdomain));

      // Add the authentication header
      client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", Convert.ToBase64String(Encoding.ASCII.GetBytes(config.ApiKey)));

      // Add an Accept header for XML format.
      client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/xml"));
    }

    public T Get<T>(string id)
    {
      var accounts = default(T);

      // Make the request and get the response from the service
      HttpResponseMessage response = client.GetAsync(string.Concat("accounts/", id)).Result;  // Blocking call!

      if (response.IsSuccessStatusCode)
      {
        // Parse the response body. Blocking!
        accounts = response.Content.ReadAsAsync<T>().Result;
      }

      return accounts;
    }
  }

这是我的模型:

  [XmlRoot("account")]
  public class Account
  {
    [XmlAttribute("href")]
    public string Href { get; set; }

    [XmlElement("account_code")]
    public string AccountCode { get; set; }

    [XmlElement("state")]
    public AccountState State { get; set; }

    [XmlElement("username")]
    public string Username { get; set; }

    [XmlElement("email")]
    public string Email { get; set; }

    [XmlElement("first_name")]
    public string FirstName { get; set; }

    [XmlElement("last_name")]
    public string LastName { get; set; }

    [XmlElement("company_name")]
    public string Company { get; set; }

    [XmlElement("accept_language")]
    public string LanguageCode { get; set; }

    [XmlElement("hosted_login_token")]
    public string HostedLoginToken { get; set; }

    [XmlElement("created_at")]
    public DateTime CreatedDate { get; set; }

    [XmlElement("address")]
    public Address Address { get; set; }
  }

以及来自服务的 XML 响应示例:

And an example of the XML response from the service:

<account href="https://mysubdomain.recurly.com/v2/accounts/SDTEST01">
  <adjustments href="https://mysubdomain.recurly.com/v2/accounts/SDTEST01/adjustments"/>
  <invoices href="https://mysubdomain.recurly.com/v2/accounts/SDTEST01/invoices"/>
  <subscriptions href="https://mysubdomain.recurly.com/v2/accounts/SDTEST01/subscriptions"/>
  <transactions href="https://mysubdomain.recurly.com/v2/accounts/SDTEST01/transactions"/>
  <account_code>SDTEST01</account_code>
  <state>active</state>
  <username>myusername</username>
  <email>[e-mail]</email>
  <first_name>First name</first_name>
  <last_name>Last name</last_name>
  <company_name>My Company Name</company_name>
  <vat_number nil="nil"></vat_number>
  <address>
    <address1>My Address Line 1/address1>
    <address2>My Address Line 2</address2>
    <city>My City</city>
    <state>My State</state>
    <zip>PL7 1AB</zip>
    <country>GB</country>
    <phone>0123456789</phone>
  </address>
  <accept_language nil="nil"></accept_language>
  <hosted_login_token>***</hosted_login_token>
  <created_at type="datetime">2013-08-22T15:58:17Z</created_at>
</account>

推荐答案

我认为问题是因为默认情况下 DataContractSerializer 用于反序列化 XML，并且默认情况下 DataContractSerializer 使用命名空间 http://schemas.datacontract.org/2004/07/Clr.Namespace.(在这种情况下，Clr.Namepace 是 RecurlyWebApi.Recurly.)

I think the problem is because by default the DataContractSerializer is being used to deserialize the XML, and by default the DataContractSerializer uses a namespace of namespace http://schemas.datacontract.org/2004/07/Clr.Namespace. (In this case Clr.Namepace is RecurlyWebApi.Recurly.)

因为您的 XML 具有属性，所以您需要使用 XmlSerializer 而不是 DataContractSerializer，并且您准备这样做是因为您的帐户类是用 Xml* 属性修饰的.但是，您必须使用使用 XmlSerializer 的 XmlMediaTypeFormatter.您可以按照 此页面:

Because your XML has attributes, you need to use the XmlSerializer instead of the DataContractSerializer, and you're set up to do this because your account class is decorated with Xml* attributes. However, you have to use an XmlMediaTypeFormatter which is using the XmlSerializer. You can do this by setting a flag on the global XMLFormatter as described on this page:

var xml = GlobalConfiguration.Configuration.Formatters.XmlFormatter;
xml.UseXmlSerializer = true;

或者通过将 MediaTypeFormatter 作为参数提供给 ReadAsAsync 调用:

or by supplying a MediaTypeFormatter as a parameter to your ReadAsAsync call:

var xmlFormatter = GlobalConfiguration.Configuration.Formatters.XmlFormatter;
xmlFormatter.UseXmlSerializer = true;
accounts = response.ReadAsAsync<T>(xmlFormatter).Result

不是 100% 确定这一点，因为这并不能解释为什么错误消息中的第一个帐户"是小写的 - DataContractSerializer 应该忽略 XmlRoot 属性.

Not 100% sure of this because this doesn't explain why the first 'account' in your error message is lower case - the DataContractSerializer should ignore the XmlRoot attribute.

这篇关于使用返回 XML 的 Recurly Rest API 时出现 WebAPI 序列化问题的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！