我的第一个webapiDemo
最近在面试，总是被问到有没有接触过webapi 或者问webapi和MVC 的区别，今天看了看，原来如此，自己理解感觉webapi和webservice一样像是实现soa 的一种形式，也可以理解为服务或者是一种数据请求框架。
下面简单的写一下我第一个webapi 实例过程。
软件环境：vs2012
1、创建ASP.NET MVC4 Web 项目->点击ok->在“新ASP.NET MVC 4项目”对话框中，选择“Web API”并点击“OK”.
2、Add a model. 名为Product.cs. 赋几个属性，代码为
namespace HelloWebAPI.Models
{
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public string Category { get; set; }
public decimal Price { get; set; }
}
}
3、Add a controller.名为ProductsController.（创建控制器时，模板选择空API控制器），然后实现方法,如下namespace HelloWebAPI.Controllers
{
using HelloWebAPI.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;
public class ProductsController : ApiController
{
//为了保持示例简单，产品被存储在该控制器类的一个固定数组中。当然，在一个实际应用程序中，你会查询一个数据库，或使用某些其它外部数据源。
Product[] products = new Product[]
{
new Product { Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 },
new Product { Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M },
new Product { Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M }
};
//无参Get方法 返回产品列表
public IEnumerable<Product> GetAllProducts()
{
return products;
}
//参数为id的Get方法 返回单个产品
public Product GetProductById(int id)
{
var product = products.FirstOrDefault((p) => p.Id == id);
if (product == null)
{
throw new HttpResponseException(HttpStatusCode.NotFound);
}
return product;
}
//参数为category的Get方法
public IEnumerable<Product> GetProductsByCategory(string category)
{
return products.Where(
(p) => string.Equals(p.Category, category,
StringComparison.OrdinalIgnoreCase));
}
}
}
4、现在我们就有了一个可以工作的webapi ，控制器上每一个方法都映射到一个Url上，如下：
5、通过浏览器调用api ie浏览器会下载json 文件 firefox 则会显示为xml格式，如下：
IE: 
Firefox:
6、现在试着浏览下面两个URL：
- http://localhost:xxxx/api/products/1
- http://localhost:xxxx/api/products?category=hardware
第一个应当返回ID等于1的词条。第二个应当返回Category等于“hardware”的所有产品的列表（这里，只有一个词条）。
7、现在以一个前台页面调用API为例，找到View下面的Home->Index.cshtml文件，写入如下代码：
- <!DOCTYPE html> <html lang="en"> <head> <title>ASP.NET Web API</title> <link href="~/Content/Site.css" rel="stylesheet" /> <script src="~/Scripts/jquery-1.7.1.min.js"></script> </head> <body id="body" > <div class="main-content"> <div> <h1>All Products</h1> <ul id="products"/> </div> <div> <label for="prodId">ID:</label> <input type="text" id="prodId" size="5"/> <input type="button" value="Search" onclick="find();" /> <p id="product" /> </div> </div> </body> <script type="text/javascript"> //getJSON()和get是一样的，都是get请求，这就决定了，发送的data数据量不能太多，否则造成url太长接收失败（getJSON方式是不可能有post方式递交的）。 //区别是，getJSON专门请求json数据的，而且getJSON可以实现跨域请求 $(document).ready(function () { // Send an AJAX request // 发送AJAX请求 $.getJSON("api/products/", function (data) { // On success, 'data' contains a list of products. // 成功时，'data'含有一组产品列表 $.each(data, function (key, val) { // Format the text to display. // 格式化文本，以便显示 var str = val.Name + ': $' + val.Price; // Add a list item for the product. // 添加一个产品列表项 $('<li/>', { text: str }) .appendTo($('#products')); }); }); //$.post("api/products/",{id:"123",name:"小明"},function(data){ // $.each(data, function (key, val) { // // Format the text to display. // // 格式化文本，以便显示 // var str = val.Name + ': $' + val.Price; // // Add a list item for the product. // // 添加一个产品列表项 // $('<li/>', { text: str }) // .appendTo($('#products')); // }); // },"json") // }); function find() { var id = $('#prodId').val(); $.getJSON("api/products/" + id, function (data) { var str = data.Name + ': $' + data.Price; $('#product').text(str); }) .fail( function (jqXHR, textStatus, err) { $('#product').text('Error: ' + err); }); } </script> </html>
8、直接运行，得到如下页面：
表明我们的HTTP服务已经在工作。你可以在文本框中输入ID并通过这个ID获得一个产品。
9、理解路由
对于每一个HTTP消息，ASP.NET Web API框架都会通过咨询一个路由表来决定接收该请求的控制器。在创建一个新的Web API项目时，该项目便会包含一个类似于下面这 样的默认路由：
/api/{controller}/{id}
{controller}和{id}部分是占位符。当框架看到一个与此模式匹配的URI时，它按以下步骤查找控制器方法：
- {controller}用来匹配控制器名
- HTTP请求的方法用来匹配方法名。（此规则仅适用于GET、POST、PUT和DELETE请求。）
- {id}，如果有，用来匹配名称为id的方法参数。
- 可能的情况下，查询参数用来匹配参数名。
其中第一个示例，“products”匹配名为ProductsController的控制器。该请求是一个GET请求，因此框架在ProductsController上查找一个名称以“GET…”开头的方法。进一步地，这个URI不包含可选的{id}片段，因此，框架查找的是一个不带参数的方法。于是，ProductsController->GetAllProducts满足所有这些需求。
第二个示例与此相同，只是该URI包含了{id}选项。因此，框架会调用GetProduct，它有一个名称为id的参数。另外，这个URI的值“5”会作为这个id参数的值进行传递。框架会根据该方法的签名，自动地把这个“5”转换成int类。
这只是个简单的Demo，个人目前只理解到这么多，希望能运用到更多更好的项目中，可以更加熟练。
我的第一个webapiDemo的更多相关文章
- Authentication in .NET Web Api
在介绍WebApi这个小demo前,先来简单说一下OAuth这个东西. OAuth开放授权,用户可以对自己的资源进行第三方授权,那么第三方就可以不用你的账号密码就可以访问你授权的资源了.比如一些论坛直 ...
- 为什么很多人坚信“富贵险中求”？
之家哥 2017-11-15 09:12:31 微信QQ微博 下载APP 摘要 网贷之家小编根据舆情频道的相关数据,精心整理的关于<为什么很多人坚信"富贵险中求"?>的 ...
- python基础全部知识点整理,超级全(20万字+)
目录 Python编程语言简介 https://www.cnblogs.com/hany-postq473111315/p/12256134.html Python环境搭建及中文编码 https:// ...
- HttpClient + ASP.NET Web API, WCF之外的另一个选择
WCF的野心造成了它的庞大复杂,HTTP的单纯造就了它的简单优美.为了实现分布式Web应用,我们不得不将两者凑合在一起 —— WCF服务以HTTP绑定宿主于IIS. 于是有了让人晕头转向的配置.让人郁 ...
- Tomcat一个BUG造成CLOSE_WAIT
之前应该提过,我们线上架构整体重新架设了,应用层面使用的是Spring Boot,前段日子因为一些第三方的原因,略有些匆忙的提前开始线上的内测了.然后运维发现了个问题,服务器的HTTPS端口有大量的C ...
- 如何一步一步用DDD设计一个电商网站（九）—— 小心陷入值对象持久化的坑
阅读目录 前言 场景1的思考 场景2的思考 避坑方式 实践 结语 一.前言 在上一篇中(如何一步一步用DDD设计一个电商网站(八)—— 会员价的集成),有一行注释的代码: public interfa ...
- 如何一步一步用DDD设计一个电商网站（八）—— 会员价的集成
阅读目录 前言 建模 实现 结语 一.前言 前面几篇已经实现了一个基本的购买+售价计算的过程,这次再让售价丰满一些,增加一个会员价的概念.会员价在现在的主流电商中,是一个不大常见的模式,其带来的问题是 ...
- SQLSERVER将一个文件组的数据移动到另一个文件组
SQLSERVER将一个文件组的数据移动到另一个文件组 有经验的大侠可以直接忽视这篇文章~ 这个问题有经验的人都知道怎麽做,因为我们公司的数据量不大没有这个需求,也不知道怎麽做实验 今天求助了QQ群里 ...
- 构建一个基本的前端自动化开发环境 —— 基于 Gulp 的前端集成解决方案（四）
通过前面几节的准备工作,对于 npm / node / gulp 应该已经有了基本的认识,本节主要介绍如何构建一个基本的前端自动化开发环境. 下面将逐步构建一个可以自动编译 sass 文件.压缩 ja ...
随机推荐
- Java中多线程原理详解
Java是少数的集中支持多线程的语言之一,大多数的语言智能运行单独的一个程序块,无法同时运行不同的多个程序块,Java的多线程机制弥补了这个缺憾,它可以让不同的程序块一起运行,这样可以让程序运行更加顺 ...
- 关于如何正确地在android项目中添加第三方jar包
在android项目中添加第三方jar包虽然不是一个很复杂的问题,但是确实给很多开发者带来了不小的困扰.我自己就曾经碰到过calss not found exception.error inflati ...
- linux下的Source命令的基本功能
source命令用法:source FileName作用:在当前bash环境下读取并执行FileName中的命令.注:该命令通常用命令“.”来替代.如:source .bash_rc 与 . .bas ...
- 本地ssh连接到vbox中的linux
本机是window xp系统, 安装vbox,在vbox下安装linux,想在xp中用ssh连接linux,此时需要配置网络. 1.设置vbox的网络,选择host-only 2.设置window虚拟 ...
- SQL递归查询知多少
最近工作中遇到了一个问题,需要根据保存的流程数据,构建流程图.数据库中保持的流程数据是树形结构的,表结构及数据如下图: 仔细观察表结构,会发现其树形结构的特点: FFIRSTNODE:标记是否为根节点 ...
- 《JAVASCRIPT高级程序设计》根植于原型链的继承
继承是面向对象的语言中,一个最为津津乐道并乐此不疲的话题之一.JAVASCRIPT中的继承,主要是依靠原型链来实现的.上一篇文章介绍过,JAVASCRIPT中,每一个对象都有一个prototype属性 ...
- C-Swipe Mobile 一个适用于Vue2.x的移动端轮播组件
近期在做的一个Vue2项目里需要一个可以滑动的轮播组件,但是又因为现有的传统轮播库功能过于繁琐和笨重.因此自己写了一个针对于Vue2.x的轻型轮播组件. 项目GitHub链接:C-Swipe Mobi ...
- Openstack容器项目之Magnum
本文以Newton版本为例. 1.Magnum简介 Magnum项目通过Openstack API能够在Openstack中创建基于容器的服务,但它本身并不直接对容器进行操作,而是通过Kubernet ...
- CSS3知识点整理（四）----布局样式及其他
包括CSS3多列布局样式.Flexbox伸缩布局.盒子模型等.重点介绍了Flexbox伸缩布局的各种属性用法. 一.多列布局 为了能在Web页面中方便实现类似报纸.杂志那种多列排版的布局,W3C特意给 ...
- Boost.Hana在visual studio 2017 rc中的残缺使用
最新的visual studio还不支持hana,不知道vs2017正式版本出后会不会支持.等不及了,先用rc版试试吧. 1.从https://github.com/boostorg/hana下载或拉 ...