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. MyBatis中Mapper的返回值类型

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

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

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

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

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

  9. ASP.NET Web API中的参数绑定总结

    ASP.NET Web API中的action参数类型可以分为简单类型和复杂类型. HttpResponseMessage Put(int id, Product item) id是int类型,是简单 ...

随机推荐

  1. java.util.concurrent.atomic 包详解

    Atomic包的作用: 方便程序员在多线程环境下,无锁的进行原子操作 Atomic包核心: Atomic包里的类基本都是使用Unsafe实现的包装类,核心操作是CAS原子操作 关于CAS compar ...

  2. 如何利用.snk文件生成DLL文件中的Publickeytoken

    1.在该路径下C:\Program Files (x86)\Microsoft SDKs\Windows\v7.0A\bin查找是否有sn.exe. 没有的话,从网上下载,注意需要的版本. 2.打开c ...

  3. css3 动画贝塞尔曲线

    http://cubic-bezier.com/#.17,.67,.83,.67 缓动函数速查表: http://www.xuanfengge.com/easeing/easeing/ Ceaser: ...

  4. 条件与(&amp;&amp;)和逻辑与(&amp;)以及条件或(||)和逻辑或(|)区别

    条件与(&&)和逻辑与(&)以及条件或(||)和逻辑或(|)区别在于它们的运算结果是不相同的. 条件与(&&)和条件或(||)采用的是所谓的"短路规则 ...

  5. JNI/NDK开发指南(一)—— JNI开发流程及HelloWorld

    转载请注明出处:http://blog.csdn.net/xyang81/article/details/41777471 JNI全称是Java Native Interface(Java本地接口)单 ...

  6. C#-Mdi多文档窗体及其子窗体的排列 ---ShinePans

    MdiLayout枚举成员及说明 Casecade s全部Mdi层叠在父窗体 TileHorizontal 水平平铺 TitleVertical 垂直平铺 Form1.cs (mdi) using S ...

  7. AngularJs练习Demo16 ngRoute

    <!DOCTYPE html> <html> <head> <meta http-equiv="Content-Type" content ...

  8. 01: 腾讯云API-云服务器

    1.1 云服务器 1.腾讯云SDK使用举例 网址:https://cloud.tencent.com/document/sdk/Python #! /usr/bin/env python # -*- ...

  9. curl: (7) Failed connect to 172.16.100.199:9200; 没有到主机的路由

    没有到主机的路由这种问题很常见,多数是由机器的防火墙没有关闭. Ubuntu 查看防火墙状态 ufw status 关闭防火墙 ufw disable centos6 查看防火墙状态 service ...

  10. 014 view-controller标签

    1.说明 可以直接相应转发的页面, 而无需再经过 Handler 的方法. 这个时候可以使用mvc:view-controller标签. 但是以前的映射会出现问题,这个时候需要再配置一个标签<m ...