(四)Asp.net web api中的坑-【api的返回值】
- void無返回值
- IHttpActionResult
- HttpResponseMessage
- 自定義類型
我這裏並不想贅述這些返回類型,
可以參考博文http://blog.csdn.net/leonken88/article/details/53063693
和大神的http://www.cnblogs.com/landeanfen/p/5501487.html
我要說我遇到的坑是,
public HttpResponseMessage DataHandler(RequestModel model)
{
不管是result = JsonConvert.SerializeObject(data);
return result,
return json<string>(result),
或者return Ok(result)
別人調用我的接口都是一個json字符串格式,”{\“name\”:\”123\”}”
}
以我想呢,既然你能收到這種字符串,自己反序列化下就ok了嘛,最後另外那邊告訴我,他們的開發語言是c++,且這個http請求都是封裝好的組件,類似dll那種只能調用,他們要求返回json,必須是{“name”:”123”},無轉義,無雙引號
這可難辦,我試了好多種方式,每次都是返回帶轉義字符的json字符串,無奈多方查閱
[HttpPost]
public HttpResponseMessage DataHandler(RequestModel model)
{string result=”{\“name\”:\”123\”}”;
return new HttpResponseMessage { Content = new StringContent(result, System.Text.Encoding.UTF8, "text/plain") };
}
這就對了,為什麽呢?
原來是自己對http協議的學習不精,
1、 服務端需要返回一段普通文本給客戶端,Content-Type="text/plain"
2 、服務端需要返回一段HTML代碼給客戶端 ,Content-Type="text/html"
3 、服務端需要返回一段XML代碼給客戶端 ,Content-Type="text/xml"
4 、服務端需要返回一段javascript代碼給客戶端,text/javascript
5 、服務端需要返回一段json串給客戶端,application/Json且
ASP.NET WebAPI是一套RESTful API開發框架。會自動序列化返回的對象成XML或JSON,其序列化後的格式取決於Request的header中的Accept。常見的有:
- application/json
- application/xml
- text/json
- text/xml(這兩種已經被廢棄了)
如果不指定的話默認返回的Content-Type是:application/json; charset=utf-8
要想http response 返回指定格式,
方法一:放棄自動序列化,返回httpResponseMessage,再手動設置
代碼如下:
HttpResponseMessage resp = new HttpResponseMessage();
string result=”{\“name\”:\”123\”}”;
resp.Content = new StringContent(result, System.Text.Encoding.UTF8, ""text/plain");
方法二:設置httpConfiguration
但是這種方法有個弊端,是全局的,但是應該可以限定範圍,暫時先不管了。
P.S.吐槽下,IE默認是不顯示JSON的,會直接下載下來,所以開發人員工具就捕獲不到HTTP報文,也沒法看Header。
更多詳情,請參考http://www.luckyonecn.com/blog/fix_content-type_to_Applicationjson_in_WebApi/
【知識點】http請求,不僅僅request中的content-type需要指定,response中的content-type也需要指定,客戶端需要告訴服務端,我給你的是什麽樣的數據,content-type,服務端處理邏輯,返回給客戶端,也需要告訴客戶端,我給你是什麽樣的數據,content-type,雙方按約定好的方式,進行通訊,才能確保整個http請求準確無誤的進行。
(四)Asp.net web api中的坑-【api的返回值】