Web API中的返回值类型
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
3.https://blog.csdn.net/lwpoor123/article/details/78644998
Web API中的返回值类型的更多相关文章
- ASP.NET Web API 中的返回数据格式以及依赖注入
本篇涉及ASP.NET Web API中的返回数据合适和依赖注入. 获取数据 public IEnumerable<Food> Get() { var results = reop.Get ...
- Asp.net MVC 中Controller返回值类型ActionResult
[Asp.net MVC中Controller返回值类型] 在mvc中所有的controller类都必须使用"Controller"后缀来命名并且对Action也有一定的要求: 必 ...
- Controller 中Action 返回值类型 及其 页面跳转的用法
•Controller 中Action 返回值类型 View – 返回 ViewResult,相当于返回一个View 页面. -------------------------------- ...
- ASP.NET MVC中Controller返回值类型ActionResult
1.返回ViewResult视图结果,将视图呈现给网页 public class TestController : Controller { //必须存在Controller\Test\Index.c ...
- MVC 中Controller返回值类型ActionResult
下面列举Asp.net MVC中Controller中的ActionResult返回类型 1.返回ViewResult视图结果,将视图呈现给网页 public ActionResult About() ...
- dotNET开发之MVC中Controller返回值类型ActionResult方法总结
1.返回ViewResult视图结果,将视图呈现给网页 2. 返回PartialViewResult部分视图结果,主要用于返回部分视图内容 3. 返回ContentResult用户定义的内容类型 4. ...
- MyBatis中Mapper的返回值类型
insert.update.delete语句的返回值类型 对数据库执行修改操作时,数据库会返回受影响的行数. 在MyBatis(使用版本3.4.6,早期版本不支持)中insert.update.del ...
- ResultMap和ResultType在使用中的区别、MyBatis中Mapper的返回值类型
在使用mybatis进行数据库连接操作时对于SQL语句返回结果的处理通常有两种方式,一种就是resultType另一种就是resultMap,下面说下我对这两者的认识和理解 resultType:当使 ...
- ASP.NET Web API 2 的返回结果
HttpResponseMessage IHttpActionResult void 某些其他类型 总结归纳 原文地址:https://www.cnblogs.com/xgzh/p/11208611. ...
随机推荐
- requirejs 使用实例r.js打包
在这里,请先看基础文章与相关技术文档: 安装: npm init npm install requirejs --save npm install jquery@1.11.1 --save 创建基本目 ...
- 【CF833E】Caramel Clouds(线段树)
[CF833E]Caramel Clouds(线段树) 题面 CF 洛谷 题解 首先把区间一段一段分出来,那么只有四种情况. 要么没有被任何一朵云被覆盖,那么直接就会产生这一段的贡献. 要么被一朵云覆 ...
- css- @media @font-face 的理解
在我的博客园定制的css中有2个之前没有遇到的csss属性@font-face @media @media 在css文件中的使用如下 ` @media screen and (max-width: 1 ...
- 工作机制.py
rpc_server.py# !/usr/bin/env python3.5# -*- coding:utf-8 -*-# __author__ == 'LuoTianShuai'"&quo ...
- [WC2014]紫荆花之恋(动态点分治+替罪羊思想)
题目描述 强强和萌萌是一对好朋友.有一天他们在外面闲逛,突然看到前方有一棵紫荆树.这已经是紫荆花飞舞的季节了,无数的花瓣以肉眼可见的速度从紫荆树上长了出来.仔细看看的话,这个大树实际上是一个带权树.每 ...
- kali源更新
对于新装kali的同学一点存在着更新源的问题 这是对初次安装,进行系统更新的教程 首先需要有gpg_key wget -q -O - https://archive.kali.org/archive- ...
- ST算法(倍增)(用于解决RMQ)
ST算法 在RMQ(区间最值问题)问题中,我了解到一个叫ST的算法,实质是二进制的倍增. ST算法能在O(nlogn)的时间预处理后,用O(1)的时间在线回答区间最值. f[i][j]表示从i位起的2 ...
- 万物互联之~RPC专栏
3.RPC引入 上篇回顾:万物互联之~深入篇 Code:https://github.com/lotapp/BaseCode/tree/master/python/6.net/6.rpc/ 其他专栏最 ...
- surface pro app
fresh paintpotplayer acg播放器 http://potplayer.daum.net/?lang=zh_CNnebo==oneNoteGesture Sign xodo pdf ...
- vue2.0项目实战(5)vuex快速入门
Vuex 是一个专为 Vue.js 应用程序开发的状态管理模式.它采用集中式存储管理应用的所有组件的状态,并以相应的规则保证状态以一种可预测的方式发生变化.Vuex 也集成到 Vue 的官方调试工具 ...