ASP.NETMVCWebAPI使用示例-创新互联

上篇博客讲解rest服务开发时，曾经提到过asp.net mvc中的rest api，由于篇幅原因，没有在上篇博客中进行讲解，这里专门拿出来进行讨论。还是一样引用上次的案例，用asp.net mvc提供的web api来进行IP地址归宿地查询接口的开发。

让客户满意是我们工作的目标，不断超越客户的期望值来自于我们对这个行业的热爱。我们立志把好的技术通过有效、简单的方式提供给客户，将通过不懈努力成为客户在信息化领域值得信任、有价值的长期合作伙伴，公司提供的服务项目有：国际域名空间、网站空间、营销软件、网站建设、鹿邑网站维护、网站推广。

由于我机器装的是win8企业版操作系统，VS版本是2012，因此我们选择使用VS自带的MVC4模版中的Web API来创建一个项目。

ASP.NET MVC 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 addresses = new List 
        {  
            new Address(){ IPAddress="1.91.38.31", Province="北京市", City="北京市" },    
            new Address(){ IPAddress = "210.75.225.254", Province = "上海市", City = "上海市"  }, 
        }; 
         
        public IEnumerable GetIPAddresses() 
        { 
            return addresses; 
        } 
         
        public Address GetIPAddressByIP(string IP) 
        { 
            return addresses.FirstOrDefault(x => x.IPAddress == IP); 
        } 
         
    } 
}

只要做上面两步就可以运行这个项目了，我们按Ctrl+F5运行整个项目，出现了如下的页面。

ASP.NET MVC Web API使用示例

我们点击右上角的API链接。

ASP.NET MVC Web API使用示例

可以看到我们定义的Web API的接口的使用方法以及说明。

既然是服务，能够被其它程序调用就需要一个持续保障它运行的环境，我们可以将这个写好的Web API的项目发布到IIS当中。

我们可以使用VS自带的发布功能进行发布，并映射到IIS应用程序目录当中。

ASP.NET MVC Web API使用示例

我们点击IIS右侧的浏览，看看服务有没有能够正常运行。

ASP.NET MVC Web API使用示例

我们按照文档的提示，我们在地址栏输入http://192.168.0.2/webapi/api/ipaddress。

ASP.NET MVC Web API使用示例

可以看到，我们收到了Web API定义的服务提供的数据。同样的我们试一下另外一个接口方法。

ASP.NET MVC Web API使用示例

OK，这样就好了。

但是如果我们需要返回JSON格式怎么办呢？有个简便的方法，在Global.asax.cs文件中，添加一个方法即可。

ASP.NET MVC Web API使用示例

关于这段代码的原因，可以参考：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使用示例

ASP.NET Web API就开发好了，至于在C#程序中怎么调用，可以参考我上篇博客中的代码。如果要在页面中调用，可以通过JQuery等JS库请求URL即可。

参考资料：

http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api

http://blog.miniasp.com/post/2012/10/12/ASPNET-Web-API-Force-return-JSON-format-instead-of-XML-for-Google-Chrome-Firefox-Safari.aspx

创新互联www.cdcxhl.cn，专业提供香港、美国云服务器，动态BGP最优骨干路由自动选择，持续稳定高效的网络助力业务部署。公司持有工信部办法的idc、isp许可证，机房独有T级流量清洗系统配攻击溯源，准确进行流量调度，确保服务器高可用性。佳节活动现已开启，新人活动云服务器买多久送多久。

分享标题：ASP.NETMVCWebAPI使用示例-创新互联
网站网址：http://myzitong.com/article/ddehog.html

ASP.NETMVCWebAPI使用示例-创新互联

其他资讯