我的第一个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 ...
随机推荐
- JS前端的分享功能
给网页加上分享代码,借助网友的力量推广网站,目前已经很流行了 以下是网页代码 QQ空间分享代码如下: <a href="javascript:void(0);" onclic ...
- 关于如何正确地在android项目中添加第三方jar包
在android项目中添加第三方jar包虽然不是一个很复杂的问题,但是确实给很多开发者带来了不小的困扰.我自己就曾经碰到过calss not found exception.error inflati ...
- FLV格式详解
Overview Flash Video(简称FLV),是一种流行的网络格式.目前国内外大部分视频分享网站都是采用的这种格式. File Structure 从整个文件上开看,FLV是由The FLV ...
- 利用forwardInvocation实现消息重定向
在obj-c中我们可以向一个实例发送消息,相当于c/c++ java中的方法调用,只不过在这儿是说发送消息,实例收到消息后会进行一些处理.比如我们想调用一个方法,便向这个实例发送一个消息,实例收到消息 ...
- Collections.sort的两种用法
http://gwh-08.iteye.com/blog/1233401/ class Foo implements Comparable<Foo>{ @Override public i ...
- windows10 subsystem(bash) 如何使用jupter notebook
按照传统惯例,应该映射端口jupyter notebook --port=15000,然后用浏览器开http://localhost:15000/ 但是当你运行python的时候,居然发现kernel ...
- 如何让微信小程序快速接入七牛云
如果你确定用七牛运行小程序的话,给大家分享一个九折优惠码:61d1fd4d1 月 9 日 微信小程序正式发布,小程序终于揭开了它神秘的面纱,开发者对小程序的追捧更是热度不减.从小程序的热门应用场景来看 ...
- webSocket错误收集
关于 使用WebSocket报如下错误, Uncaught InvalidStateError: Failed to execute 'send' on 'WebSocket': already in ...
- 多线程方式实现Socket通信
一.首先,介绍下两类传输协议:TCP:UDP TCP是Tranfer Control Protocol的 简称,是一种面向连接的保证可靠传输的协议.通过TCP协议传输,得到的是一个顺序的无差错的数据流 ...
- 有趣的++i和i++
作为一个天天和代码“约会”的人来说i++和++i这玩意再熟悉不过了,因为使用频率太高了. 虽然如此,但也未必见得我们真的了解她,不妨猜猜下面的输出结果. #inlcude <stdio.h> ...