通过 http Post 请求将 XML 发送到 Web Api 的问题答案

【问题标题】：Issue with sending XML to Web Api via http Post request通过 http Post 请求将 XML 发送到 Web Api 的问题
【发布时间】：2016-09-22 07:34:19
【问题描述】：

我想将以下 XML 文档发送到我的 Web Api 2 控制器；但是，[FromBody] 参数始终为空。

这是请求 XML 正文：

<razorInbound server="PortfolioExposureServer" request="lookupRiskPointRecord">
  <caller>RazorClient</caller>
  <responseMode>xml</responseMode>
  <body>
    <conditions>
      <fromOffset>0</fromOffset>
      <top>100</top>
      <condition>
        <keyPath>
          <keyElement nodeOffset='1'>Currency</keyElement>
          <keyElement nodeOffset='2'>ID</keyElement>
        </keyPath>
        <lookupValue>USD</lookupValue>
      </condition>
    </conditions>
  </body>
</razorInbound>

使用 Postman 发送请求，如下：

POST /api/razorXmlRequest HTTP/1.1
Host: localhost:5000
Content-Type: application/xml
Cache-Control: no-cache
Postman-Token: 6ca91ebf-31e0-77f2-6f81-cb9993b69b1a

<razorInbound server="PortfolioExposureServer" request="lookupRiskPointRecord">
  <caller>RazorClient</caller>
  <responseMode>xml</responseMode>
  <body>
    <conditions>
      <fromOffset>0</fromOffset>
      <top>100</top>
      <condition>
        <keyPath>
          <keyElement nodeOffset='1'>Currency</keyElement>
          <keyElement nodeOffset='2'>ID</keyElement>
        </keyPath>
        <lookupValue>USD</lookupValue>
      </condition>
    </conditions>
  </body>
</razorInbound>

还有 Web Api 2 控制器：

注意：param 参数始终为 null

我相信我需要一个正确的类定义来正确映射 XML 请求，但我不确定如何构造它。

using System;
using System.Threading.Tasks;
using System.IO;
using System.Text;
using RazorServices;
using System.Net.Http;
using System.Web.Http;
using System.Xml.Linq;
using System.Net;
using System.Xml;

namespace RazorWebApi.Controllers
{
    [Route("api/razorXmlRequest")]
    public class RazorXmlRequestController : ApiController
    {
        public class RawXml {
            public string RazorXml { get; set; }
        }

        [HttpPost]
        public async Task<HttpResponseMessage> Post([FromBody]RawXml param )
        {
            HttpResponseMessage resp = new HttpResponseMessage(HttpStatusCode.OK);

            // code omitted...
			
            return resp;
        }
    }
}

顺便说一句，我们目前正在通过设置一个StreamReader 对象从this.Request.Content 拉取来解决这个问题；但是在我的单元测试中，我需要将我的 xml 作为参数发送。

[HttpPost]
        public async Task<HttpResponseMessage> Post()   // [FromBody]RawXml param )
        {
            HttpResponseMessage resp = new HttpResponseMessage(HttpStatusCode.OK);

            StreamReader sr = new StreamReader(await this.Request.Content.ReadAsStreamAsync(), Encoding.UTF8);
            string xml = sr.ReadToEnd();

            if (xml == null || xml.Length < 4)
            {
                throw new RazorServicesException("Invalid XML");
            }
            RazorSession cred = RzWebApi.Cred;
            string reply = await RzWebApi.RazorSrv.xmlRequests.Request(cred, xml);
            resp.Content = new StringContent(reply, System.Text.Encoding.UTF8, "text/plain");
            return resp;
        }

【问题讨论】：

标签： asp.net-web-api2 webapp2

【解决方案1】：

您可以将 Web API 配置为在您的WebApiConfig.Register 中使用XmlSerializer，如下所示；

config.Formatters.XmlFormatter.UseXmlSerializer = true;

【讨论】：

原来我可以把Post方法改成Post([FromBody]XElement param )和header的Content-Type: application/xml，这样就可以解决问题了。即使没有上面的建议，xml 内容也会传递给控制器。

【解决方案2】：

最终解决方案是将 Post 参数类型更改为 XElement:

[Route("api/razorXmlRequest")]
public class RazorXmlRequestController : ApiController
{
    /// <summary>
    /// Raw Razor request XML 
    /// </summary>
    /// <returns>Razor reply message as text</returns>
    [HttpPost]
    public async Task<HttpResponseMessage> Post([FromBody]XElement xml)
    {
        HttpResponseMessage resp = new HttpResponseMessage(HttpStatusCode.OK);
        RazorSession cred = RzWebApi.Cred;
        string reply = await RzWebApi.RazorSrv.xmlRequests.Request(cred, xml);
        resp.Content = new StringContent(reply, System.Text.Encoding.UTF8, "application/xml");
        return resp;
    }
}

正如上面的先生们所建议的那样，这甚至没有提供XmlFormatter（@TusharJ，无论如何感谢您的意见）。

【讨论】：

我尝试了类似的方法，但出现错误。 stackoverflow.com/questions/68128537/….请指教。