【WEB API項目實戰干貨系列】- WEB API入門(一)

這篇做為這個系列的第一篇，做基本的介紹，有經驗的人可以直接跳到第二部分創建 ProductController。

 

創建 Web API 項目

在這里我們使用VS2013, .NET 4.5.1創建一個Web API 2的項目

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

在這里不實用安全

 

這樣我們一個項目就初始化好了, 這都要歸功於微軟強大的VS

 

F５啟動項目之后, 點擊界面上API按鈕可以看到默認創建的API

 

這時就可以用上面的地址通過一些測試工具來測試了. 這里推薦使用fiddler, 后面我們也將廣泛使用這款工具來做調試.

 

創建我們自己的API-Products API

相關操作步驟如下

添加ProductController

 

在這里我們設計產品相關的API URL如下, 雖然這個不完全符合RESTFul標准，如有糾結的人直接忽略， 這里主要介紹如何把我們的URL定制成下面這個樣子(也是我們項目中的樣子):

當然這里的API URL還有其他寫法，這個有興趣的后面章節可以再討論。

我們的 Product API簡單的設計為下面格式:

添加獲取產品分頁API: api/products/product/getList
添加獲取單個產品API: api/products/product/get?productId=產品ID
添加產品新增API: api/products/product/add?productId=產品ID
添加產品更新API: api/products/product/update?productId=產品ID
添加產品刪除API: api/products/product/delete?productId=產品ID

在這里我們在剛才新添加的ProductController里中實現上面的API

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

        [HttpGet, Route("product/get")]
        public Product GetProduct(Guid productId)
        {
            throw new NotImplementedException();
        }

        [HttpPost, Route("product/add")]
        public Guid AddProduct(Product product)
        {
            throw new NotImplementedException();
        }

        [HttpPost, Route("product/update")]
        public void UpdateProduct(Guid productId, Product product)
        {
            throw new NotImplementedException();
        }

        [HttpDelete, Route("product/delete")]
        public void DeleteProduct(Guid productId)
        {
            throw new NotImplementedException();
        }
    }

添加之后啟動程序，看到的結果如下

 

OK, 到這里大家加上自己的后端業務邏輯，完成業務層面的操作就可以發布使用了。

 

本章代碼： 代碼下載(代碼托管在CSDN Code)