ASP.NET Web API使用示例
原文地址：https://blog.csdn.net/chinacsharper/article/details/21333311
上篇博客讲解rest服务开发时，曾经提到过asp.net mvc中的rest api，由于篇幅原因，没有在上篇博客中进行讲解，这里专门拿出来进行讨论。还是一样引用上次的案例，用asp.net 提供的web api来进行IP地址归宿地查询接口的开发。
由于我机器装的是win8企业版操作系统，VS版本是2012，因此我们选择使用VS自带的MVC4模版中的Web API来创建一个项目。
点击确定后，VS会自动为我们创建一个完整的可运行的ASP.NET Web API的项目。
从项目的目录结构可以看出，ASP.NET Web API与ASP.NET MVC项目的结构几乎一致。我们删除为我们默认创建并打开的ValuesController文件（示例性文件，可以参考）。
既然要打造一个IP地址查询服务接口，为了跟上文的服务形式一致，我们还是使用GET请求方式的服务，不过我们这次使用MVC中的Web API来实现。
首先在Models文件夹中建立一个Address模型类。
- namespace MvcWebApi.Models
- {
- public class Address
- {
- public string IPAddress { get; set; }
- public string Province { get; set; }
- public string City { get; set; }
- }
- }
接着我们在Controllers文件夹下建立一个IPAddressController控制器，需要注意的是，这个IPAddressController一定要继承自ApiController类，这样服务才能暴露出来。
- namespace MvcWebApi.Controllers
- {
- public class IPAddressController : ApiController
- {
- private static IList<Address> addresses = new List<Address>
- {
- new Address(){ IPAddress="1.91.38.31", Province="北京市", City="北京市" },
- new Address(){ IPAddress = "210.75.225.254", Province = "上海市", City = "上海市" },
- };
- public IEnumerable<Address> GetIPAddresses()
- {
- return addresses;
- }
- public Address GetIPAddressByIP(string IP)
- {
- return addresses.FirstOrDefault(x => x.IPAddress == IP);
- }
- }
- }
只要做上面两步就可以运行这个项目了，我们按Ctrl+F5运行整个项目，出现了如下的页面。
我们点击右上角的API链接。
可以看到我们定义的Web API的接口的使用方法以及说明。
既然是服务，能够被其它程序调用就需要一个持续保障它运行的环境，我们可以将这个写好的Web API的项目发布到IIS当中。
我们可以使用VS自带的发布功能进行发布，并映射到IIS应用程序目录当中。
我们点击IIS右侧的浏览，看看服务有没有能够正常运行。
我们按照文档的提示，我们在地址栏输入http://192.168.0.2/webapi/api/ipaddress。
可以看到，我们收到了Web API定义的服务提供的数据。同样的我们试一下另外一个接口方法。
OK，这样就好了。
但是如果我们需要返回JSON格式怎么办呢？有个简便的方法，在Global.asax.cs文件中，添加一个方法即可。
关于这段代码的原因，可以参考：http://blog.miniasp.com/post/2012/10/12/ASPNET-Web-API-Force-return-JSON-format-instead-of-XML-for-Google-Chrome-Firefox-Safari.aspx，这里不重复。
我们运行这个项目后，重新发布。
当我们再次在浏览器中运行时，就可以看到默认返回的是JSON格式了（IE默认就是JSON）。
ASP.NET MVC Web API就开发好了，至于在C#程序中怎么调用，可以参考我上篇博客中的代码。如果要在页面中调用，可以通过JQuery等JS库请求URL即可。
__________________________________________________________________________________________________________________________________________
有朋友说开发是会开发了，但不知道怎么调用啊？那么这里我就演示一下如何进行跨域调用Web API，算是对上面博客的补充。
因为在浏览器中是不允许跨域访问Web API的（为了安全），所以必须要对我们开发的Web API添加跨域功能。在Web API中添加跨域功能非常简单，只需要引入一个包Microsoft.AspNet.WebApi.Cors即可，直接通过Nuget安装即可。
然后在WebApiConfig里面添加跨域支持代码：
EnableCorsAttribute的构造函数指定的三个参数均为*，表示支持所有的访问。第一个参数表示访问的源；第二个参数表示访问的头信息；第三个参数表示允许的方法，比如：HEAD、OPTIONS、DELETE、GET、POST等等。
最后将Web API项目编译发布到IIS，然后就可以通过jQuery调用Web API。
完整的HTML调用Web API的代码如下：
- <html>
- <head>
- <script src="jquery-1.4.2.js"></script>
- <script type="text/javascript">
- $(function(){
- $.ajax({
- type:'get',
- async: false,
- url:'http://10.77.137.120:9876/Api/IPAddress',
- dataType:'JSON',
- data:{},
- success:function(result){
- var json = JSON.parse(result);
- for(var i = 0;i<json.length;i++){
- $("#citys").append("<tr><td>"+(parseInt(i)+1)+"</td><td>"+json[i].IPAddress+"</td><td>"+json[i].Province+"</td><td>"+json[i].City+"</td></tr>");
- }
- }
- });
- });
- </script>
- </head>
- <body>
- <table id="citys" cellspacing=0 cellpadding=0 border=1>
- <thead>
- <th>序号</th>
- <th>IP</th>
- <th>省份</th>
- <th>地市</th>
- </thead>
- </table>
- </body>
- </html>
参考资料：
http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api
ASP.NET Web API使用示例的更多相关文章
- ASP.NET Web API 开篇示例介绍
ASP.NET Web API 开篇示例介绍 ASP.NET Web API 对于我这个初学者来说ASP.NET Web API这个框架很陌生又熟悉着. 陌生的是ASP.NET Web API是一个全 ...
- ASP.NET Web API 入门示例详解
REST服务已经成为最新的服务端开发趋势,ASP.NET Web API即为.NET平台的一种轻量级REST架构. ASP.NET Web API直接借鉴了ASP.NET MVC的设计,两者具有非常类 ...
- C#版ASP.NET Web API使用示例
为更好更快速的上手Webapi设计模式的接口开发,本文详细解释了在Web API接口的开发过程中,我们可能会碰到各种各样的问题总结了这篇,希望对大家有所帮助. 1:在接口定义中确定MVC的get或者P ...
- ASP.net Web API综合示例
目录 概述 功能介绍 程序结构 服务器端介绍 客户端介绍 “契约” Web API设计规则 并行写入冲突与时间戳 身份验证详解 Web API验证规则 客户端MVVM简介 Web.Config 本DE ...
- 支持Ajax跨域访问ASP.NET Web Api 2(Cors)的简单示例教程演示
随着深入使用ASP.NET Web Api,我们可能会在项目中考虑将前端的业务分得更细.比如前端项目使用Angularjs的框架来做UI,而数据则由另一个Web Api 的网站项目来支撑.注意,这里是 ...
- Asp.Net Web Api 2 实现多文件打包并下载文件示例源码_转
一篇关于Asp.Net Web Api下载文件的文章,之前我也写过类似的文章,请见:<ASP.NET(C#) Web Api通过文件流下载文件到本地实例>本文以这篇文章的基础,提供了Byt ...
- ASP.NET MVC Web API使用示例
上篇博客讲解rest服务开发时,曾经提到过asp.net mvc中的rest api,由于篇幅原因,没有在上篇博客中进行讲解,这里专门拿出来进行讨论.还是一样引用上次的案例,用asp.net mvc提 ...
- 在ASP.NET Web API 2中使用Owin OAuth 刷新令牌(示例代码)
在上篇文章介绍了Web Api中使用令牌进行授权的后端实现方法,基于WebApi2和OWIN OAuth实现了获取access token,使用token访问需授权的资源信息.本文将介绍在Web Ap ...
- ASP.NET Web API Model-ActionBinding
ASP.NET Web API Model-ActionBinding 前言 前面的几个篇幅把Model部分的知识点划分成一个个的模块来讲解,而在控制器执行过程中分为好多个过程,对于控制器执行过程(一 ...
随机推荐
- 第十五章 springboot + pojo默认值设置
我们有时需要给POJO设置默认值 pojo设置(推荐) 1.User package com.xxx.firstboot.domain; import lombok.Getter; import lo ...
- hdu1226 超级密码 (BFS,里面用了大数取余原理)
Problem Description Ignatius花了一个星期的时间终于找到了传说中的宝藏,宝藏被放在一个房间里,房间的门用密码锁起来了,在门旁边的墙上有一些关于密码的提示信息: 密码是一个C进 ...
- Page Redirect Speed Test
现在,有两种方法可以实现网页的自动跳转. (1) 用html自带的<meta>标签(如下)可以实现网页的自动跳转,而且可以控制跳转的延时. <meta http-equiv=&quo ...
- Insertion Sort List Leetcode java
题目: Sort a linked list using insertion sort. 题解: Insertion Sort就是把一个一个元素往已排好序的list中插入的过程. 初始时,sorted ...
- ArcGIS中的AddIn开发示例
AddIn开发的插件效率高.操作简单.容易管理.方便共享.它还可以和Python结合(后面的博文中应该会涉及到),非常强大.下面简单描述一下ArcGIS中的AddIn开发过程: 1.在安装ArcGIS ...
- SpringMVC上传文件的三种方式（转载）
直接上代码吧,大伙一看便知 这时:commonsmultipartresolver 的源码,可以研究一下 http://www.verysource.com/code/2337329_1/common ...
- IOS学习笔记44--ASIRequestHttp之BUG（一）
其实这也是无意间看到的,大家看看是不是这么回事 BUG:当下载线程数超过2时,就会影响到主线程响应用户请求的速度了 看ASIRequestHttp.m--requestFinished代码 - (vo ...
- Java监控工具
1. jmap 查看heapdump 2. jstack 查看javacore 3.jps 列出jvm进程 4.jstatd 启动jvm监控服务.它是一个基于 ...
- vue inheritAttrs、$attrs和$listeners使用
inheritAttrs.$attrs和$listeners使用场景: 组件传值,尤其是祖孙组件有跨度的传值. (1)inheritAttrs 属性说明:https://cn.vuejs.org/v2 ...
- HDU 4847 陕西邀请赛A(水)
HDU 4847 Wow! Such Doge! pid=4847" style="">题目链接 题意:给定文本,求有几个doge,不区分大写和小写 思路:水题.直 ...