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"
}