程式師世界 >> 編程語言 >> .NET網頁編程 >> ASP.NET >> ASP.NET基礎 >> 創建一個完整的ASP.NET Web API項目

創建一個完整的ASP.NET Web API項目

編輯：ASP.NET基礎

Visual Studio為我們提供了專門用於創建ASP.NET Web API應用的項目模板，借助於此項目模板提供的向導，我們可以“一鍵式”創建一個完整的ASP.NET Web API項目。在項目創建過程中，Visual Studio會自動為我們添加必要的程序集引用和配置，甚至會為我們自動生成相關的代碼，總之一句話：這種通過向導生成的項目在被創建之後其本身就是一個可執行的應用。
一、通過VS2013、.NET 4.5.1創建一個Web API項目
1、解決方案下面新建項目

2、選擇項目WEB API模板, 在最下方的MVC主要是默認會自帶微軟的API Helper, 使用MVC發布

3、安全選擇

4、點擊確定按鈕，VS2013將生成一個簡單的Web API項目

5、運行項目，啟動項目之後, 點擊界面上API按鈕可以看到默認創建的API

6、新建一個Products API
(1)、添加ProductController
(2)、選擇empty 控制器

(3)、在ProductController裡中實現API

 [RoutePrefix("api/products")]
  public class ProductController : ApiController
  {
    //獲取產品分頁API: api/products/product/getList 
    [HttpGet, Route("product/getList")]
    public Page<Product> GetProductList()
    {
      throw new NotImplementedException();
    }

    //獲取單個產品API: api/products/product/get?productId=產品ID 
    [HttpGet, Route("product/get")]
    public Product GetProduct(Guid productId)
    {
      throw new NotImplementedException();
    }

    //產品新增API: api/products/product/add?productId=產品ID
    [HttpPost, Route("product/add")]
    public Guid AddProduct(Product product)
    {
      throw new NotImplementedException();
    }

    //產品新增API: api/products/product/add?productId=產品ID
    [HttpPost, Route("product/update")]
    public void UpdateProduct(Guid productId, Product product)
    {
      throw new NotImplementedException();
    }

    //產品刪除API: api/products/product/delete?productId=產品ID 
    [HttpDelete, Route("product/delete")]
    public void DeleteProduct(Guid productId)
    {
      throw new NotImplementedException();
    }
  }

二、ASP.NET Web API 特性
1、先進的 HTTP 編程模型
使用新的強類型的 HTTP 對象模型直接操作 HTTP 請求和響應，在 HTTP客戶端使用相同的編程模型和 HTTP 管道；
2、支持路由
Web API 完整支持 ASP.NET 路由，包括路由參數和約束。此外，到動作的映射支持約定，從此將不再需要向類或者方法添加類似於 [HttpPost] 之類的屬性；
3、內容協商
客戶端與服務端可以一起決定 API 返回數據的格式。默認支持 XML， JSON 以及 Form URL-Encoded 格式，可以擴展添加自定義格式，甚至可以替換掉默認的內容協商策略；
4、模型綁定與驗證
模型綁定器可以輕易地從 HTTP 請求中提取數據並轉換成在動作方法中使用的 .Net 對象；
5、過濾
Web API 支持過濾，包括總所周知的 [Authorize] 過濾標記，可以為 Action 添加並插入自定義過濾，實現認證、異常處理等；
6、查詢聚合
只要簡單的返回 Iqueryable<T> ， Web API 將會支持通過 OData 地址約定進行查詢；
7、改進的 Http 細節可測試性
Web API 不是將 HTTP 細節設置到一個靜態的 Context 對象上，而是使用 HttpRequestMessage 和HttpResponseMessage 實例，可以使用這些對象的泛型版本為這些 Http 類型添加自定義類型；
8、改進的依賴反轉 (IoC) 支持
Web API 使用 MVC Dependency Resolver 實現的服務定位器模式在不同的場景下來獲取實例；
9、基於代碼的配置
Web API 單獨使用代碼完成配置，從而保證了配置文件的整潔；
10、自托管 (Self-Host)
Web API 除了可以托管在 IIS 中，還可以托管在進程中，依舊可以使用路由以及其它的特性。