ASP.NET Web API入門介紹（一）-有解無憂

隨著專案的復雜度越來越高，各種第三方系統的資料互動也越來越頻繁，不可避免的就要用到Web API介面，這里Web API是一個比較寬泛的概念，本文提到Web API特指ASP.NET Web API，本文以一些簡單的小例子，簡述ASP.NET Web API的相關基礎知識，僅供學習分享使用，如有不足之處，還請指正，

什么是RESTful?

REST全稱是Representational State Transfer，中文意思是表述狀態轉移，REST本身并沒有創造新的技術、組件或服務，而隱藏在RESTful背后的理念就是使用Web的現有特征和能力，更好地使用現有Web標準中的一些準則和約束，如果一個架構符合REST的約束條件和原則，我們就稱它為RESTful架構，對于RESTful，原作者是這樣描述的【我這篇文章的寫作目的，就是想在符合架構原理的前提下，理解和評估以網路為基礎的應用軟體的架構設計，得到一個功能強、性能好、適宜通信的架構，】

綜合上面的解釋，我們總結一下什么是RESTful架構：

每一個URI代表一種資源；
客戶端和服務器之間，傳遞這種資源的某種表現層；
客戶端通過四個HTTP動詞，對服務器端資源進行操作，實作"表現層狀態轉化"，

什么是Web API?

ASP.NET Web API基于C#構建安全的符合REST風格的API，通過ASP.NET Web API，可以快速創建在各個客戶端進行呼叫的服務，包括Web瀏覽器端和移動端等，如下所示：

為什么要用Web API?

ASP.NET Web API是??一個框架，可以很容易構建達成了廣泛的HTTP服務客戶端，包括瀏覽器和移動設備，是構建RESTful應用程式的理想平臺的.NET框架，在系統架構中的地位，如下所示：

創建ASP.NET Web API專案

檔案--新建--專案打開【創建新專案】視窗，然后選擇【ASP.NET Web應用程式（.NET Framework）】，點擊下一步，如下所示：

進入【配置新專案】視窗，輸入專案名稱，選擇專案保存路徑，然后點擊【創建】，如下所示：

進入【創建新的ASP.NET Web應用程式】創建，選擇【空】，然后添加【MVC,Web API】核心參考，然后點擊【創建】如下所示：

稍等片刻，專案即創建成功，目錄結構如下所示：

App_Start目錄下RouteConfig.cs為MVC核心參考，主要用于注冊MVC路由配置
App_Start目錄下WebApiConfig.cs為Web API的核心參考，主要用于注冊Web API的路由配置，
默認創建了Controllers，Models，Views三個目錄，分別用于存放三層架構各自的內容，

創建第一個介面

在Controllers檔案夾，右鍵--添加--Web API控制器類，如下所示：

然后輸入控制器名稱，以Controller結尾，點擊【確定】，如下所示：

通過模板創建的控制器，自動添加了示例代碼，且默認繼承ApiController，如下所示：

 1 namespace WebApiDemo.Controllers
 2 {
 3     public class StudentController : ApiController
 4     {
 5         // GET api/<controller>
 6         public IEnumerable<string> Get()
 7         {
 8             return new string[] { "value1", "value2" };
 9         }
10 
11         // GET api/<controller>/5
12         public string Get(int id)
13         {
14             return "value";
15         }
16 
17         // POST api/<controller>
18         public void Post([FromBody] string value)
19         {
20         }
21 
22         // PUT api/<controller>/5
23         public void Put(int id, [FromBody] string value)
24         {
25         }
26 
27         // DELETE api/<controller>/5
28         public void Delete(int id)
29         {
30         }
31     }
32 }

定制API

為了進行測驗，首先新建Model類Student，如下所示：

 1 using System;
 2 using System.Collections.Generic;
 3 using System.Linq;
 4 using System.Text;
 5 using System.Threading.Tasks;
 6 
 7 namespace WebApiDemo.Models
 8 {
 9     public class Student
10     {
11         public int Id { get; set; }
12 
13         public string Name { get; set; }
14 
15         public int Age { get; set; }
16 
17         public bool Sex { get; set; }
18     }
19 }

1. GET方式

在StudentController中，參考Models命名空間中的Student模型，修改Get方法，如下所示：

默認情況下，WebApi模板自動創建了兩個Get方法，一個無參，一個有參，分別回傳串列和具體實體，進行調整，回傳Student資料，如下所示：

 1 // GET api/<controller>
 2 public IEnumerable<Student> Get()
 3 {
 4       return new Student[] { new Student() {
 5            Id=1,
 6            Name="Alan.hsiang",
 7            Age=20,
 8            Sex=true
 9        }, new Student() {
10            Id=2,
11            Name="Json.hsiang",
12            Age=18,
13            Sex=false
14         } };
15 }
16 
17 // GET api/<controller>/5
18 public Student Get(int id)
19 {
20       return new Student()
21        {
22             Id = 1,
23             Name = "Alan.hsiang",
24             Age = 20,
25             Sex = true
26         };
27 }

然后運行VisualStudio，默認埠為44311，通過PostMan進行測驗，

不帶引數，回傳Student串列，如下所示：

帶引數的，回傳某個具體的Student實體，id可以通過api/Controller/id的方式進行傳遞，如下所示：

2. POST方式

POST方法主要是通過body表單的方式進行提交，本例修改自帶的代碼，接收入參Student實體，回傳Student字串，如下所示：

1 // POST api/<controller>
2 public string Post([FromBody] Student value)
3 {
4       return string.Format("學生的ID={0}，姓名={1}，年齡={2}，性別={3}",value.Id,value.Name,value.Age,value.Sex);
5 
6 }

通過Postman，進行訪問，訪問方式選擇POST，Body選擇raw，資料格式選擇JSON，如下所示：

3. PUT方式

PUT方式一般用于修改資料，本例為了測驗，回傳接收的ID，如下所示：

1 // PUT api/<controller>/5
2 public int Put(int id, [FromBody] string value)
3 {
4       //為了測驗，回傳接收到的id
5       return id;
6 }

通過Postman進行測驗，請求方式選擇PUT，Body內容如果只有一個string型別引數，則引數名為空，如下所示：

4. DELETE方式

DELETE方式一般用于洗掉資料，本例為了測驗，回傳一個字串，如下所示：

1 // DELETE api/<controller>/5
2 public string Delete(int id)
3 {
4       return string.Format("Id={0} 已洗掉", id);
5 }

通過Postman進行測驗，請求方式選擇DELETE，如下所示：

總結

通過以上示例的測驗，總結如下：

訪問路徑，符合RESTful的風格，通過請求方式進行區分具體的功能，如下所示：
- GET 請求串列：https://localhost:44311/api/Student
- GET 請求單一實體：https://localhost:44311/api/Student/1
- POST請求：https://localhost:44311/api/Student/
- PUT方式：https://localhost:44311/api/Student/3
- DELETE方式：https://localhost:44311/api/Student/4
請求資料格式：
- GET方式，一般采用URL的方式進行傳遞引數
- POST，PUT，DELETE方式，采用body傳參，格式一般文JSON，

通過以上總結，發現WebAPI與RESTful風格架構不謀而合，

同一方式多個引數

在本例中，如果有多個GET方式的請求方法，且引數格式，個數不同，應該如何匹配，如下所示：

 1 // GET api/<controller>
 2 public IEnumerable<Student> Get()
 3 {
 4       return new Student[] { new Student() {
 5            Id=1,
 6            Name="Alan.hsiang",
 7            Age=20,
 8            Sex=true
 9         }, new Student() {
10            Id=2,
11            Name="Json.hsiang",
12            Age=18,
13            Sex=false
14         } };
15 }
16 
17 // GET api/<controller>/5
18 public Student Get(int id)
19 {
20      return new Student()
21      {
22           Id = 1,
23           Name = "Alan.hsiang",
24           Age = 20,
25           Sex = true
26        };
27 }
28 
29 // GET api/<controller>/5?name=aabbcc
30 public Student Get(int id,string name)
31 {
32       return new Student()
33       {
34            Id = id,
35            Name = name,
36            Age = 22,
37            Sex = true
38         };
39 }

前兩種方式以通過Postman進行測驗，現在測驗第三種方式，如下所示：

同一方式，不同名稱

通過以上示例，可以看出方法名和請求方式是一一對應的，那如果方法名和請求方式不一致呢？

首先增加GetStudent方式，為了區分，在回傳的Name值分別寫了0和1，如下所示：

// GET api/<controller>/5?name=aabbcc
public Student Get(int id,string name)
{
        return new Student()
        {
            Id = id,
            Name = name+"---0",
            Age = 22,
            Sex = true
         };
}

public Student GetStudent(int id, string name)
{
       return new Student()
       {
            Id = id,
            Name = name+"---1",
            Age = 22,
            Sex = true
        };
}

打開Postman進行測驗，直接報錯，稱找到了兩個符合格式的資源的，如下所示：

以上問題，通過查看WebApiConfig.cs即可發現，WebApi注入的routeTemplate是api/{controller}/{id}，沒有action做區分，此處和MVC不同，WebApi注冊默認路由模板，如下所示：

 1 namespace WebApiDemo
 2 {
 3     public static class WebApiConfig
 4     {
 5         public static void Register(HttpConfiguration config)
 6         {
 7             // Web API 配置和服務
 8 
 9             // Web API 路由
10             config.MapHttpAttributeRoutes();
11 
12             config.Routes.MapHttpRoute(
13                 name: "DefaultApi",
14                 routeTemplate: "api/{controller}/{id}",
15                 defaults: new { id = RouteParameter.Optional }
16             );
17         }
18     }
19 }

Route特性

為了解決兩個訪問方式相同，引數相同，但是方法名不同，會導致獲取報錯的問題，WepApi引入了路由特性，如下所示：

 1 [Route("api/Student/QueryStudent/{id}")]
 2 [HttpGet]
 3 public Student QueryStudent(int id, string name)
 4 {
 5      return new Student()
 6      {
 7           Id = id,
 8           Name = name + "---1",
 9           Age = 22,
10           Sex = true
11      };
12 }

如下，通過Postman進行訪問，則可以正常訪問，默認訪問Get(int id,string name)

通過路由特性，訪問/api/Student/QueryStudent/4?name=HEX，如下所示：

路由前綴

通過路由特性，完美解決了一個Controller，同一種方式，同時訪問兩個不同的方法的問題，但是如果每一個路由特性都寫全稱，也會很繁瑣，且容易出錯，所以路由前綴，應運而生，

路由前綴修飾Controller，路由特性修飾Action，如下所示：

 1 namespace WebApiDemo.Controllers
 2 {
 3     [RoutePrefix("api/Teacher")]
 4     public class TeacherController : ApiController
 5     {
 6         public string Get(int id, string name) {
 7             return string.Format("[Get]正在查找的老師id={0}，姓名={1}", id, name);
 8         }
 9 
10         [Route("query/{id}")]
11         [HttpGet]
12         public string QueryTeacher(int id, string name) {
13             return string.Format("[Query]正在查找的老師id={0}，姓名={1}", id, name);
14         }
15     }
16 }

這樣在訪問時，即可區分，默認訪問Get方法，如下所示：

通過路由特性，訪問Query方法，如下所示：

備注

以上就是ASP.NET Web API基礎知識的簡單介紹，本文旨在拋磚引玉，共同學習，一起進步，

清平調·其一李白〔唐代〕

云想衣裳花想容，春風拂檻露華濃，若非群玉山頭見，會向瑤臺月下逢，

清平調·其二李白〔唐代〕

一枝秾艷露凝香，云雨巫山枉斷腸，借問漢宮誰得似，可憐飛燕倚新妝，

清平調·其三李白〔唐代〕

名花傾國兩相歡，長得君王帶笑看，解釋春風無限恨，沉香亭北倚闌干，

作者：Alan.hsiang
出處：http://www.cnblogs.com/hsiang/
本文著作權歸作者和博客園共有，寫文不易，支持原創，歡迎轉載【點贊】，轉載請保留此段宣告，且在文章頁面明顯位置給出原文連接，謝謝，
關注個人公眾號，定時同步更新技術及職場文章

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/351882.html

標籤：.NET技术

上一篇：.NET ORM 分表分庫怎么做

下一篇：C# WPF MVVM模式下在主表單顯示子表單并獲取結果