WebApi中的返回值类型大致可分为四种: Void/ IHttpActionResult/ HttpResponseMessage /自定义类型

一、Void

  void申明方法没有返回值,执行成功后返回204状态码。使用起来十分简单:

public class NewsController : ApiController
{
[HttpPost]
public void AddNews(News news)
{
}
}

前端Ajax请求代码:

$(function () {
$.ajax({
type: 'post',
url: 'http://localhost:60761/api/News',
data: { Id: , Title: "新闻1", Desc: '这是第一条新闻' },
success: function (data) {
alert(data);
}
})
})

二、IHttpActionResult

2.1  json

  和MVC一样,Web API中的IHttpActionResult也提过Json方法来返回JsonReuslt类型。

List<News> newsList = new List<News>
{
new News{Id=,Title="新闻1",Desc="这是新闻1"},
new News{Id=,Title="新闻2",Desc="这是新闻2"},
new News{Id=,Title="新闻3",Desc="这是新闻3"},
};
[HttpGet]
public IHttpActionResult GetUserList()
{
  //Json<T>方法返回一个JsonResult,JsonResult是IHttpActionResult的实现类
return Json<List<News>>(newsList);
}

前端ajax请求代码:

$(function () {
$.ajax({
type: 'get',
url:'http://localhost:60761/api/News',
data: {},
success: function (data) {
console.log(data)
}
})
});

Json方法也支持返回匿名类型,如下:

[HttpGet]
public IHttpActionResult GetUserList()
{
//Json方法返回一个JsonResult,JsonResult是IHttpActionResult的实现类
var list = newsList.Where(n => n.Id > ).Select(n => new { n.Title, n.Desc });
return Json(list);

2.2  Ok和NotFound

  Ok()和Ok(T content)返回一个OkResult实例,OkResult是IHttpActionResult的实现类

2.2.1  Ok返回简单类型

[HttpGet]
public IHttpActionResult GetUserList()
{
//Ok<T>方法返回一个OkResult,OkResult是IHttpActionResult的实现类
return Ok<string>("成功了!");
//return Ok<List<News>>(newsList);
}

前端ajax请求代码:

$(function () {
$.ajax({
type: 'get',
url:'http://localhost:60761/api/News',
data: {},
success: function (data) {
console.log(data)
}
})
});

2.2.2 Ok返回复杂类型

List<News> newsList = new List<News>
{
new News{Id=,Title="新闻1",Desc="这是新闻1"},
new News{Id=,Title="新闻2",Desc="这是新闻2"},
new News{Id=,Title="新闻3",Desc="这是新闻3"},
}; [HttpGet]
public IHttpActionResult GetNewsList()
{
//Ok<T>方法返回一个OkResult,OkResult是IHttpActionResult的实现类
//return Ok<string>("成功了!");
return Ok<List<News>>(newsList); }

2.2.3 NotFound 返回404

List<News> newsList = new List<News>
{
new News{Id=,Title="新闻1",Desc="这是新闻1"},
new News{Id=,Title="新闻2",Desc="这是新闻2"},
new News{Id=,Title="新闻3",Desc="这是新闻3"},
}; public IHttpActionResult GetNewsListById(int id)
{
//NotFound方法返回一个NotFoundResult实例,
//NotFoundResult实现了IHttpActionResult接口,返回404
News news = newsList.Where(n => n.Id == id).SingleOrDefault();
if (news==null)
{
return NotFound();
}
else
{
return Json<News>(news);
}

前端ajax请求:

$(function () {
$.ajax({
type: 'get',
url:'http://localhost:60761/api/News',
data: {id:},
success: function (data) {
console.log(data)
}
})
});

2.3  其他类型

IHttpActionResult的实现类还有几种,使用起来也十分简单,列举如下:

2.3.1  Content

public IHttpActionResult Get()
{
return Content<string>(HttpStatusCode.OK, "成功了!");
}

2.3.2  BadRequest

public IHttpActionResult Get()
{
return BadRequest("错误请求!");
}

2.3.3  Redirect(string)

public IHttpActionResult Get()
{
return Redirect("http://localhost:60761/api/News/Welcome");
} [Route("api/News/Welcome")]
[HttpGet]
public IHttpActionResult RedirectHere()
{
return Content(HttpStatusCode.OK, "跳转成功!");
}

2.4  自定义类型(IHttpActionResult的实现类)

IHttpActionResult只有一个接口方法: ExecuteAsync ,这个方法的作用就是 异步地返回HttpResponseMessage 。一个返回分页结果的栗子:

//分页结果类实现IHttpActionResult
public class PageResult : IHttpActionResult
{
object _value;
HttpRequestMessage _request;
public PageResult(object value,HttpRequestMessage request)
{
_value = value;
_request = request;
} //只有这一个接口方法
public Task<HttpResponseMessage> ExecuteAsync(CancellationToken cancellationToken)
{
var response = new HttpResponseMessage()
{
Content = new ObjectContent(typeof(object), _value, new JsonMediaTypeFormatter()),
StatusCode = HttpStatusCode.OK,
ReasonPhrase = "服务器留言内容",
RequestMessage=_request
};
return Task.FromResult(response);
}
} List<News> newsList = new List<News>
{
new News{Id=,Title="新闻1",Desc="这是新闻1"},
new News{Id=,Title="新闻2",Desc="这是新闻2"},
new News{Id=,Title="新闻3",Desc="这是新闻3"},
};
//在Action中返回分页结果类型
public IHttpActionResult Get(int offset,int limit)
{
var result = newsList.Skip(offset).Take(limit);
return new PageResult(result, Request);
}

前端ajax调用:

$(function () {
$.ajax({
type: 'get',
url:'http://localhost:60761/api/News',
data: {offset:,limit:},
success: function (data) {
console.log(data)
}
})
});

三、HttpResponseMessage

  我们可以直接返回HttpResponseMessage,通常使用 request.CreateResponse 方法生成一个HttpResponseMessage对象。

public HttpResponseMessage Get(int offset,int limit)
{
var result = newsList.Skip(offset).Take(limit);
return Request.CreateResponse(HttpStatusCode.OK, newsList, "application/json");
}

四、其他类型

  我们也可以像写普通方法返回List,string,Array...等类型,WebAPI在管道事件会使用媒体格式化器(Media-type formmater)这些类型自动序列化,如我们返回一个List集合:

public List<News> Get(int offset,int limit)
{
var result = newsList.Skip(offset).Take(limit);
return newsList;
}

参考文献:

1.http://www.cnblogs.com/landeanfen/p/5501487.html

2.https://www.asp.net/web-api

3.https://blog.csdn.net/lwpoor123/article/details/78644998

Web API中的返回值类型的更多相关文章

  1. ASP.NET Web API 中的返回数据格式以及依赖注入

    本篇涉及ASP.NET Web API中的返回数据合适和依赖注入. 获取数据 public IEnumerable<Food> Get() { var results = reop.Get ...

  2. Asp.net MVC 中Controller返回值类型ActionResult

    [Asp.net MVC中Controller返回值类型] 在mvc中所有的controller类都必须使用"Controller"后缀来命名并且对Action也有一定的要求: 必 ...

  3. Controller 中Action 返回值类型 及其 页面跳转的用法

        •Controller 中Action 返回值类型 View – 返回  ViewResult,相当于返回一个View 页面. -------------------------------- ...

  4. ASP.NET MVC中Controller返回值类型ActionResult

    1.返回ViewResult视图结果,将视图呈现给网页 public class TestController : Controller { //必须存在Controller\Test\Index.c ...

  5. MVC 中Controller返回值类型ActionResult

    下面列举Asp.net MVC中Controller中的ActionResult返回类型 1.返回ViewResult视图结果,将视图呈现给网页 public ActionResult About() ...

  6. dotNET开发之MVC中Controller返回值类型ActionResult方法总结

    1.返回ViewResult视图结果,将视图呈现给网页 2. 返回PartialViewResult部分视图结果,主要用于返回部分视图内容 3. 返回ContentResult用户定义的内容类型 4. ...

  7. MyBatis中Mapper的返回值类型

    insert.update.delete语句的返回值类型 对数据库执行修改操作时,数据库会返回受影响的行数. 在MyBatis(使用版本3.4.6,早期版本不支持)中insert.update.del ...

  8. ResultMap和ResultType在使用中的区别、MyBatis中Mapper的返回值类型

    在使用mybatis进行数据库连接操作时对于SQL语句返回结果的处理通常有两种方式,一种就是resultType另一种就是resultMap,下面说下我对这两者的认识和理解 resultType:当使 ...

  9. ASP.NET Web API 2 的返回结果

    HttpResponseMessage IHttpActionResult void 某些其他类型 总结归纳 原文地址:https://www.cnblogs.com/xgzh/p/11208611. ...

随机推荐

  1. POJ 3460 Booksort(算竞进阶习题)

    IDA* 这题真不会写..估价函数太巧妙了.. 按照lyd神牛的说法我们把a[i+1]=a[i]+1记为正确后继,反之则记为错误后继 那么考虑最优的一次交换区间,至多能够纠正三个错误后继,所以我们统计 ...

  2. PHP 事务写法

    $md=new Model(); //创建事务 $md->startTrans(); //开始事务 $md->table("ym_xxx")->where(&qu ...

  3. Web页面执行shell命令

    本文以apache为web服务器为例 安装apache服务yum -y install httpd 启动apachesystemctl restart httpd 创建shell脚本cd /var/w ...

  4. 一种使用 emwin 绘制图片的方法

    @2018-12-10 [小记] 使用官方 <GUIBuilder.exe> 软件里的 Image 控件,注意格式为 .bmp,这种方式是将图片数据直接转为十六进制数据存储至静态区 具体使 ...

  5. javascript的性能优化tips

    谈到javascript的性能优化,有好多点,比如把script放到离body闭合标签附近,合并多个script标签等等,还有一些代码的性能,for的性能不如while的性能好,用while模拟for ...

  6. golang go语言通道类型的通道示例 通道的通道

    几点注意:go的无缓存通道 通道make 创建后,即使里面是空的,也可以取里面内容.但是程序会被阻塞. 通道的规则是没人取,是不能往里面放的.放的线程会阻塞. 最外层的requestChan相当于一个 ...

  7. HDU/HDOJ 2087 剪花布条

    KMP裸题 (极限5分钟A题) /** freopen("in.in", "r", stdin); freopen("my.out", &q ...

  8. 既然写CSS很容易,那为什么大家还是把CSS写的那么烂呢?

    在众成翻译上看到一篇不错的css文章,所以就给转过来. 在你开始阅读这篇文章之前,一定要做好心理准备.因为我写的 90% 都是在发牢骚,只有最后大概 10% 介绍 CSS 技巧之最佳实践.提前给你们打 ...

  9. css3 media

    @media screen and (max-width: 320px) { .cloud{position:;top: 70%;width: 150px;} .cloud2{;top: 30%;wi ...

  10. [luogu3388][割点]

    题目链接 思路 真板子题.割点是指在一个无向图中,删去之后图将不再连通的点.可以用tarjan算法求.根据割点有两种情况,一种是根,一种是非根.如果不是根的就去判断在tarjan的时候当前节点所能到的 ...