在Asp.Net MVC項目中創建一個API

最近在忙一個MVC項目,Leader要求創建一個API,可通過某個link獲得某個記錄的信息。

本來想通過View來返回一個JSON記錄,當我創建Controller時發現有一個API Controller,想必是MVC已經具備這個功能了,所以抱着試一試的心態,迅速補習了一下MVC API知識,馬上現學現賣。

選擇Controller文件夾,右鍵,選擇Add...,選擇API



命名未ABCController.cs, 並加入以下代碼,注意方法GetUser,一定要求[HttpGet]修飾,其中key和username是要傳入的參數。

public class ABCController : ApiController
{
    public ABCController()
    {

    }

    [HttpGet]
    public IEnumerable<Models.User> GetUser(string key, string username)
    {
        Models.User user;
        ......
        Models.User[] users = new Models.User[] { user };
        return users;
    }
}

代碼很簡單,debug調試,通過網址http://localhost:12345/API/ABC/GetUser?key=...&username=abc訪問API,這個link返回的是一個XML網頁,雖然不是JSON,但處理起來也很方便。注意link中的\API\路徑是固定的。爲了保證安全性,我增加了key密鑰,可使用GUID來代替,只有提供了正確的key才能得到結果。



發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章