ASP.NET Web API简单学习
Web API 簡介
Web API可以返回 json、xml類型的數據,對于數據的增刪改查,提供了對應的資源操作,按照要求的類型進行處理,主要包括:Get(查),Post(增),Put(改),Delete(刪),這些都是Http協議支持的請求方式。
? ? ? ? ? ? ?
Web API的請求方式:根據路由規則請求?。
WebService 和 Web API兩種Web服務的比較:
| WebService | 基于SOAP風格的網絡服務,使用方法進行請求 |
| Web API | 基于REST風格的網絡服務,使用資源進行請求 |
Web API 中5個方法分別是查單個、查所有、增加、修改、刪除。?
微軟有了WebService和WCF為什么還要Web API?
用過WCF的人應該都清楚,面對一大堆復雜的配置文件,萬一出了問題,真的會叫人抓狂,而且不同的客戶端調用的也不是很方便。不得不承認WCF的功能確實是很強大,可是有時候我們不需要那么復雜的功能,只需要簡單的僅通過使用HTTP或者HTTPS來調用增刪改查,這時候,Web API就應運而生了。那么什么時候考慮使用WebAPI呢?
| 需要WebService但是不需要SOAP |
| 需要在已有的WCF服務基礎上建立non-soap-based http服務 |
| 只想發布一些簡單的HTTP服務,不想使用相對復雜的WCF配置 |
| 發布的服務可能會被帶寬受限的設備訪問 |
| 希望使用開源框架,關鍵時候可以自己調試或者定義一下框架 |
?
創建 WebAPI?
首先新建一個WebAPI項目:
建完以后的目錄結構是這樣的:
? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ???
?
在Models目錄中新建類 Product,代碼如下圖所示:
public class Product{public int id { get; set; }public string Name { get; set; }public string Category { get; set; }public decimal Price { get; set; }}在Controller文件夾下添加控制器, 注意要選擇Web API 控制器,如下圖所示:
Controller中默認示例化了一個Product類并添加了一些初始化的數據,實際情況要從數據庫取數據,如下圖所示:
using System; using System.Collections.Generic; using System.Linq; using System.Net; using System.Net.Http; using System.Text; using System.Web.Http; using WebApplication1.Models;namespace WebApplication1.Controllers {public class ProductsController : ApiController{List<Product> products = new List<Product>{new Product { id = 1,Name = "Tomato Soup",Category = "Grocerices",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}};[HttpGet]public IHttpActionResult GetAllProducts() => Json<List<Product>>(products);[HttpGet]public IHttpActionResult GetProduct(int id) => Json<Product>(products.FirstOrDefault(p => p.id == id));[HttpPost]public IHttpActionResult PostProduct(Product proudct){products.Add(proudct);return Json<List<Product>>(products);}[HttpPut]public IHttpActionResult PutProduct(Product product){var pro = products.FirstOrDefault(p => p.id == product.id);pro.Name = product.Name;pro.Category = product.Category;pro.Price = product.Price;return Json<Product>(pro);}[HttpDelete]public IHttpActionResult DeleteProduct(int id){products.RemoveAt(id);return Json<List<Product>>(products);}} }修改index.cshtml頁面,去掉默認的代碼,添加如下代碼,用于測試Web API:
<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head><title>Product App</title> </head> <body><div><h2>All Product</h2><ul id="products"></ul></div><div><h2>Search by ID</h2><input type="text" id="prodId" size="5"/><input type="button" value="Search" onclick="find()"/><p id="product"></p></div><div><h3>Add Product</h3>id <input id="id" type="text"/><br />Name:<input id="name" type="text" /><br />Category:<input id="category" type="text" /><br />Price:<input id="price" type="text" /><br /><input type="button" value="AddP" onclick="Add()"/></div><div><h3>update Product</h3>id <input id="up_id" type="text" /><br />Name:<input id="up_name" type="text" /><br />Category:<input id="up_category" type="text" /><br />Price:<input id="up_price" type="text" /><br /><input type="button" value="UpdataP" onclick="update()" /></div><div><h3>delete Product</h3>id <input id="delete_id" type="text"/><br /><input type="button" value="DeleteP" onclick="deletep()" /></div> </body> </html> <script src="~/Scripts/jquery-1.10.2.min.js"></script> <script type="text/javascript">var url = "api/products";//用于保存用戶輸入數據var Product = {create: function () {Id: "";Name: "";Category: "";Price: "";return Product;}}$(document).ready(function () {$.getJSON(url).done(function (data) {$.each(data, function (key, item) {$('<li>', { text: formatItem(item) }).appendTo($('#products'));})})});function formatItem(item){return item.Name + ': $' + item.Price;}function find(){var id = $('#prodId').val();$.getJSON(url + '/' + id).done(function (data) {$('#product').text(formatItem(data));}).fail(function (jqXHR, textStatus, err) {$('#product').text('Error:' + err);});}function Add(){var newProduct = Product.create();newProduct.Id = $("#id").val();newProduct.Price = $("#price").val();newProduct.Name = $("#name").val();newProduct.Category = $("#category").val();$.ajax({url: "/api/Products",type: "POST",contentType: "application/json; charset=utf-8",data: JSON.stringify(newProduct),success: function (data) {$('ul li').remove()$.each(data, function (key, item) {$('<li>', { text: formatItem(item) }).appendTo($('#products'));})},error: function (XMLHttpRequest, textStatus, errorThrown) {alert("請求失敗,消息:" + textStatus + " " + errorThrown);}});}function update(){var newProduct = Product.create();newProduct.Id = $("#up_id").val();newProduct.Price = $("#up_price").val();newProduct.Name = $("#up_name").val();newProduct.Category = $("#up_category").val();$.ajax({url: "/api/Products",type: "PUT",contentType: "application/json; charset=utf-8",data: JSON.stringify(newProduct),success: function (data) {$('#product').text(formatItem(data));},error: function (XMLHttpRequest, textStatus, errorThrown) {alert("請求失敗,消息:" + textStatus + " " + errorThrown);}});}function deletep(){$.ajax({url: "/api/Products",type: "DELETE",contentType: "application/json; charset=utf-8",data: { "id": $("#delete_id").val() },success: function (data) {$('ul li').remove()$.each(data, function (key, item) {$('<li>', { text: formatItem(item) }).appendTo($('#products'));})},error: function (XMLHttpRequest, textStatus, errorThrown) {alert("請求失敗,消息:" + textStatus + " " + errorThrown);}});} </script>運行以后即可測試,框架會自動根據不同類型的http請求去尋找control中對應的方法,測試頁面如下圖所示:
? ? ? ? ? ? ??
?
總結
以上是生活随笔為你收集整理的ASP.NET Web API简单学习的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: C# 中的 is 和 as 运算符 简单
- 下一篇: 精通ASP.NET MVC ——模型绑定