Hello Web Api

Web Api 2 - Hello World 示例

我們將建立一個新的 Web Api 簡單應用程式，它使用訊息和使用者名稱返回給我們 Json。
開始吧！ 首先使用 Visual Studio 建立新的 Web Api 專案，然後選擇 Empty Template。一定要檢查 Web Api 資料夾：

注意我沒有選擇 Web Api 模板，因為它新增了對 ASP.NET MVC 的引用以提供 API 幫助頁面。在這樣的基礎應用中，我們並不需要它。

新增模型

模型是一個 C#類，代表我們的應用程式中的一些資料。ASP.NET Web API 能夠自動將模型序列化為 JSON，XML 或其他一些格式（取決於配置）。

在我們的應用程式中，我們將只建立一個模型，但真實世界的應用程式通常有很多。

在解決方案資源管理器中，右鍵單擊 Models 資料夾。接著選擇 Add ，然後選擇 Class 。將類命名為 HelloMessage。我們的模型需要兩個屬性： MessageText 和 UserName ：

namespace WebApiHelloWorld.Models
{
    public class HelloMessage
    {
        public string MessageText { get; set; }
        public string UserName { get; set; }
    }
}

新增控制器

控制器處理 HTTP 請求。我們的應用程式只需要一個控制器，它返回帶有 Hello 訊息和使用者名稱的 Json（我們將在 URL 中傳遞）。
在解決方案資源管理器中，右鍵單擊 Controllers 資料夾。接著選擇 Add ，然後選擇 Controller 。在開啟的視窗中，選擇 Web API Controller - Empty ，然後單擊 Add 。

將控制器名稱設定為 HelloController。接下來編輯建立控制器的程式碼。我們需要新增返回 Hello 訊息的方法。

using System.Web.Http;
using WebApiHelloWorld.Models;

namespace WebApiHelloWorld.Controllers
{
    public class HelloController : ApiController
    {
        public HelloMessage GetMessage(string name)
        {
            HelloMessage message = new HelloMessage
            {
                MessageText = "Hello my Dear!",
                UserName = name
            };

            return message;
        }
    }
}

注意務必新增 using WebApiHelloWorld.Models。沒有它，你的控制器將找不到 HelloMessage 類。

完

就這樣！ 現在，你只需構建並啟動應用程式。只需按 Ctrl + F5 或只需按 F5 （無需除錯即可啟動）。Visual Studio 將推出 Web 瀏覽器。你需要呼叫你的控制器。為此，請在 URL“/ api / hello？name = John”的末尾新增。結果應該是：

{
    "MessageText": "Hello my Dear!",
    "UserName": "John"
}