Webapi的接口返回值主要有四種類型

void無(wú)返回值

IHttpActionResult

HttpResponseMessage

自定義類型

void無(wú)返回值

大家都知道void聲明的是一個(gè)無(wú)返回值的方法，聲明一個(gè)api控制器方法，例如：

使用postman，測(cè)試接口：

?

可以看到，void聲明的接口，在請(qǐng)求成功的時(shí)候得不到返回值，而且會(huì)返回http的狀態(tài)碼為204，表示沒(méi)有返回值。

?

IHttpActionResult

IHttpActionResult是WebApi最常用的一種返回值類型，常用的方式有：Json(T content)、Ok()、 Ok(T content)、NotFound()、Content(HttpStatusCode statusCode, T value)、BadRequest()、Redirect(string location)等

Json(T content)

在WebApi的ApiController這個(gè)抽象類里面，為我們封裝了Json(T content)這個(gè)方法，它的用法和MVC里面的JsonResult基本類似。

?

?

為什么可以返回 Json(T content)呢，轉(zhuǎn)到Json(T content)的定義，發(fā)現(xiàn)它返回的是JsonResult對(duì)象

?

再轉(zhuǎn)到JsonResult的定義，發(fā)現(xiàn)它實(shí)現(xiàn)了IHttpActionResult接口

?

當(dāng)然也可以使用dynamic來(lái)返回一個(gè)對(duì)象

?

Ok()、 Ok(T content)

如果返回Ok()，就表示不向客戶端返回任何信息，只告訴客戶端請(qǐng)求成功。

[HttpGet]publicIHttpActionResultgetJson() {returnOk(); }

?

?

Ok(T content)向客戶端返回一個(gè)成功的對(duì)象

[HttpGet]publicIHttpActionResultgetJson1() {stringresult ="請(qǐng)求成功！";returnOk(result); }

?

?

NotFound()

NotFound()方法會(huì)返回一個(gè)404的錯(cuò)誤到客戶端。

[HttpGet]publicIHttpActionResultgetJson() {returnNotFound(); }

?

?

Content(HttpStatusCode statusCode, T value)

向客戶端返回值和http狀態(tài)碼。

[HttpGet]publicIHttpActionResultgetJson() {returnContent(HttpStatusCode.OK,"OK"); }

?

?

BadRequest()

向客戶端返回400的http錯(cuò)誤。

[HttpGet]publicIHttpActionResultgetJson2() {returnBadRequest(); }

?

?

Redirect(string location)

將請(qǐng)求重定向到其他地方。

[HttpGet]publicIHttpActionResultgetJson3() {returnRedirect("http://localhost:7408/api/Values/getJson1"); } [HttpGet]publicIHttpActionResultgetJson1() {stringresult ="請(qǐng)求成功！";returnOk(result); }

?

?

HttpResponseMessage

HttpResponseMessage這個(gè)對(duì)象，表示向客戶端返回一個(gè)http響應(yīng)的消息對(duì)象（包含http狀態(tài)碼和需要返回客戶端的消息）。這個(gè)對(duì)象也有它獨(dú)特的使用場(chǎng)景：需要向客戶端返回HttpResponse時(shí)就要用到這個(gè)對(duì)象。以導(dǎo)出為例，由于需要將導(dǎo)出的Excel文件輸出到客戶端瀏覽器，Webapi的服務(wù)端需要向Web的客戶端輸出文件流，這個(gè)時(shí)候一般的IHttpActionResult對(duì)象不方便解決這個(gè)問(wèn)題，于是HttpReponseMessage派上了用場(chǎng)。

自定義類型

你也可以將webapi的接口和普通方法一樣，返回任意的類型，WebApi會(huì)自動(dòng)序列化你自定義任何返回類型，然后將序列化的值寫到響應(yīng)正文里，狀態(tài)碼統(tǒng)一返回200。

?

?