Question

我正试图找出一种使用ASP.NET WebApi返回非200返回代码的自定义有效负载的方法。基本上我想要

{"status":{"code":"40001", "message": "Field XXX can not be empty"}}

和

<status><code>40001</code><message>Field XXX can not be empty</message></status>

我正在使用HttpError类，通过添加带有重新获取的有效负载的Dictionary来实现。它适用于JSON，但是对于XML来说是失败的，据我所知，归结为XmlSerializer和HttpError不能很好地发挥作用。

这是一个简短的代码片段，可以重现完全相同的错误：

var error = new HttpError();
var status = new Dictionary<string, string>
{
    {"code", "40001"},
    {"text", "Field XXX can not be empty"}
};
error.Add("status", status);
var ser = new XmlSerializer(error.GetType());
StringWriter strWriter = new StringWriter();
ser.Serialize(strWriter, error);

在这种情况下，我得到Xml type 'xdt:untypedAtomic' does not support a conversion from Clr type 'KeyValuePair 2' to Clr type 'String'

下一步是要意识到KeyValuePair不可序列化，并创建单独的类：

[XmlType(TypeName="Status")]
public class ResponseStatus
{
  public ResponseStatus(){}
  public String Code 
  { get; set; }

  public String Text
  { get; set; }
}

它本身序列化很好，但如果在HttpError中使用则抛出相同的异常： Xml type 'List of xdt:untypedAtomic' does not support a conversion from Clr type 'ResponseStatus' to Clr type 'String'.

我不相信之前没有人这样做过，所以我想知道我错过了什么？

Answer 1

你也可以这样做;

HttpError err = new HttpError();
err["code"] = "40001";
err["text"] = "Field XXX can not be empty";

然后通过控制器级别的HttpResponseMessage返回它，即

return Request.CreateResponse(HttpStatusCode.--, err);

让您返回{＆＃34;状态＆＃34;：{＆＃34;代码＆＃34;：＆＃34; 40001＆＃34;，＆＃34;消息＆＃34;：＆＃34;字段XXX不能为空＆＃34;}}，您可能需要创建复杂类型，即

public class ResponseStatus
{
    public Status status { get; set; }
}

public class Status
{
     public string code { get; set; }
     public string message { get; set; }
}

然后从你的控制器中实例化这两个类，即

Status st = new Status();
st.code = "40001";
st.message = "Field XXX can not be empty";

ResponseStatus responsStatus = new ResponseStatus();
responsStatus.status = st;
return Request.CreateResponse(HttpStatusCode.OK, responsStatus);

要更好地控制输出，请考虑使用DataContract和DataMember为属性装饰类。从这些名称空间System.ComponentModel.DataAnnotations并使用System.Runtime.Serialization即

[DataContract]
class Status
{
      [DataMember(Name = "code")]
      public string code { get; set; }
      [DataMember(Name = "message")]
      public string message { get; set; }
}

Web Api中自定义有效内容的Http错误

1 个答案: