WebAPI用法

昨天看了兩篇文章：

ASP.NET Web API（一）：使用初探，GET和POST數據【Parry】

HttpClient + ASP.NET Web API, WCF之外的另一個選擇【dudu】

通過這兩篇文章讓我了解了WEB API的簡單用法。

Parry是在MVC中使用WebAPI：在Visual Studio 2012中新建MVC4項目，在App_Start目錄下有一個WebApiConfig.cs文件，這個文件中就是相應的Web API的路由配置了。

我也根據這兩篇文章寫了一個簡單的測試程序。

先創建了一個UserModel

public class UserModel
{
    public string UserID { get; set; }
    public string UserName { get; set; }
}

然后添加Web API Controller

public class UserController : ApiController
{
    public UserModel getAdmin()
    {
        return new UserModel() { UserID = "000", UserName = "Admin" };
    } 
}

注冊路由

public static void Register(HttpConfiguration config)
{
    config.Routes.MapHttpRoute(
        name: "DefaultApi",
        routeTemplate: "api/{controller}/{id}",
        defaults: new { id = RouteParameter.Optional }
    );
}

在Global中注冊

protected void Application_Start(object sender, EventArgs e)
{
    WebApiConfig.Register(GlobalConfiguration.Configuration);
}

這個時候用地址欄訪問地址：api/user/getadmin

這個時侯默認返回的是XML數據模型。

使用AJAX請求這個api，指定數據格式為json

$.ajax({
    type: 'GET',
    url: 'api/user/getadmin',
    dataType: 'json',
    success: function (data, textStatus) {
        alert(data.UserID + " | " + data.UserName);
    },
    error: function (xmlHttpRequest, textStatus, errorThrown) {
    }
});

alert出來的結果是：

這樣看來，真的是dudu所說的，可以根據請求的數據類型返回指定的數據格式。

 

POST數據

修改一下controller，添加一個add方法

public bool add(UserModel user)
{
    return user != null;
}

只為了測試，所以這里只判斷一下傳入的實體是否為空，如果不為空則返回true

我在頁面上添加了一個button，代碼如下：

<input type="button" name="btnOK" id="btnOK" value="發送POST請求" />

添加JS代碼

$('#btnOK').bind('click', function () {
    //創建ajax請求，將數據發送到后台處理
    var postData = {
        UserID: '001',
        UserName: 'QeeFee'
    };
    $.ajax({
        type: 'POST',
        url: 'api/user/add',
        data: postData,
        dataType: 'json',
        success: function (data, textStatus) {
            alert(data);
        },
        error: function (xmlHttpRequest, textStatus, errorThrown) {
        }
    });
});

再次運行頁面

我們附加進程進行調試，在發送ajax請求的時候，服務器段接收到的數據如圖：