簡單的ASP.NET Web API程式碼示例

周凌翔發表於2017-03-06
ASP.NETWebAPI

前言：

一個簡單的Web API例項，通過自己編寫Web API的程式碼來可以更好的感悟Web API的執行機制，廢話不多說，直接上程式碼，希望同為初學者的同學能夠跟著敲一遍，所有程式碼通過除錯，可自行在原有基礎上進行修改和擴充套件，有任何疑問還請不吝賜教。

 

正文：

 

1、首先建立一個空的Web專案，注意是Empty，而非Web API

 

注意：

這裡一定要引入如下DLL：

Json.NET

System.NET.Http 

System.Web.Http

System.Web.Http.WebHost

 

 

 

 

1.1. 大體的目錄是這樣的，沒有明確規定，讀者可自行擬定目錄

 

 

2、首先建立一個WebApiConfig的配置檔案，這裡名稱可自行擬定，主要用來定義Web API的路由

 

 詳細程式碼如下：

 

 1 namespace Ryan4_WebAPI_Application_01
 2 
 3 {
 4 
 5     public class WebApiConcifg
 6 
 7     {
 8 
 9         public static void Register(HttpConfiguration config)
10 
11         {
12 
13             config.Routes.MapHttpRoute(
14 
15                 name: "DefaultApi",
16 
17                 routeTemplate: "api/{controller}/{action}/{id}",
18 
19                 defaults: new { id = RouteParameter.Optional }
20 
21                 );
22 
23         }
24 
25     }
26 
27 }

 

 

 

接下來必須要建立一個asax檔案，來註冊這個定義的API Route

在Application_Start中加入如下程式碼，有了這句後方能在程式執行後使用Web API方式定位你的控制器和方法

 1         protected void Application_Start(object sender, EventArgs e)
 2         {
 3             Web_API_Config.Register(GlobalConfiguration.Configuration);
 4         }
 5 
 6         protected void Session_Start(object sender, EventArgs e)
 7         {
 8 
 9         }
10 
11         protected void Application_BeginRequest(object sender, EventArgs e)
12         {
13 
14         }
15 
16         protected void Application_AuthenticateRequest(object sender, EventArgs e)
17         {
18 
19         }
20 
21         protected void Application_Error(object sender, EventArgs e)
22         {
23 
24         }
25 
26         protected void Session_End(object sender, EventArgs e)
27         {
28 
29         }
30 
31         protected void Application_End(object sender, EventArgs e)
32         {
33 
34         }
35     }

 

 3、建立資料實體Users.cs

 

 詳細程式碼如下：

 

 1 namespace Ryan4_WebAPI_Application_01.Model.Entities
 2 
 3 {
 4 
 5     public class Users
 6 
 7     {
 8 
 9         public int Id { get; set; }
10 
11         public string UName { get; set; }
12 
13         public string UPass { get; set; }
14 
15         public int UAge { get; set; }
16 
17         public string UAddress { get; set; }
18 
19     }
20 
21 }

 

 

 

4、建立控制器：UserController.cs

 

 

 1 namespace Ryan4_WebAPI_Application_01.Controller
 2 
 3 {
 4 
 5     public class UserController : ApiController
 6 
 7     {
 8 
 9         public List<Users> GetUser()
10 
11         {
12 
13             var userList = new List<Users>
14 
15             {
16 
17                 new Users { Id = 1, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
18 
19                 new Users { Id = 2, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
20 
21                 new Users { Id = 3, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
22 
23                 new Users { Id = 4, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
24 
25                 new Users { Id = 5, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
26 
27                 new Users { Id = 6, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
28 
29                 new Users { Id = 7, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
30 
31                 new Users { Id = 8, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
32 
33                 new Users { Id = 9, UName = "Ryan Chow", UPass = "123456", UAge = 27, UAddress = "Earth"},
34 
35             };
36 
37  
38 
39             var temp = (from u in userList select u).ToList();
40 
41             return temp;
42 
43         }
44 
45     }
46 
47 }

 

 

 

 

5、最後F5除錯專案，輸入localhost:5381/api/user/getuser

 

 

相關文章