C# Web API 创建、发布与部署以及 API 调用

随着互联网的发展，Web API（应用程序接口）已成为现代应用程序中不可或缺的一部分。C# 是一种广泛使用的编程语言，它提供了强大的工具来创建和管理 Web API。本文将介绍如何创建 C# Web API、发布和部署它，以及如何调用 API。

一、创建 C# Web API

1.1 环境准备

在开始之前，我们需要准备开发环境。确保已安装以下工具：

• Visual Studio（推荐使用2019或2022版本）
• .NET SDK（建议使用最新版本）

1.2 创建项目

1. 打开 Visual Studio，选择“创建新项目”。
2. 选择“ASP.NET Core Web 应用程序”，点击“下一步”。
3. 输入项目名称，并选择保存位置，点击“创建”。
4. 在“创建新的 ASP.NET Core Web 应用程序”窗口中，选择“API”模板，并确认 “启用 OpenAPI 支持” 选项。

1.3 编写 API 代码

在创建的项目中，找到 Controllers 文件夹，默认会有一个 WeatherForecastController.cs 文件。我们可以修改或创建新的控制器，例如创建一个简单的用户管理 API。

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;

namespace MyWebApi.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class UsersController : ControllerBase
    {
        private static List<string> users = new List<string> { "Alice", "Bob" };

        [HttpGet]
        public ActionResult<IEnumerable<string>> GetUsers()
        {
            return Ok(users);
        }

        [HttpPost]
        public ActionResult AddUser([FromBody] string user)
        {
            users.Add(user);
            return CreatedAtAction(nameof(GetUsers), new { name = user }, user);
        }
    }
}

在上述代码中，我们定义了一个简单的用户控制器，提供了两个 API 接口：获取用户列表和添加用户。

二、发布与部署

2.1 发布 API

1. 在 Visual Studio 中右键点击项目名称，选择“发布”。
2. 选择发布目标，可以选择 Azure、文件系统或者其他云服务。此处我们以文件系统为例。
3. 设置发布的文件夹路径，例如 C:\Publish\MyWebApi，然后点击“完成”。
4. 点击“发布”按钮，Visual Studio 将会处理发布过程。

2.2 部署 API

如果选择了文件系统作为发布目标，只需将发布文件夹的内容拷贝到服务器的特定目录下。例如，可以在 IIS 中创建一个新的网站，指向该目录。

• 在服务器上安装并配置 IIS。
• 在 IIS 管理器中，右键点击“网站”，选择“添加网站”。
• 配置网站名称、物理路径（指向发布的文件夹）及端口。

确保服务器启用了 .NET Core 运行时，以使应用程序正常运行。

三、调用 API

使用 Postman 或者其他 HTTP 客户端工具来调用我们的 API。

3.1 获取用户列表

使用 GET 请求：

GET http://localhost:5000/api/users

3.2 添加用户

使用 POST 请求：

POST http://localhost:5000/api/users
Content-Type: application/json

"Alice"

通过以上步骤，我们成功创建并部署了一个简单的 C# Web API，并能够进行基本的 API 调用。这仅仅是一个简单的示范，C# Web API 还支持更多复杂的特性，如身份验证、版本控制和中间件等，开发者可以根据需求进一步扩展功能。希望通过本文，能够帮助大家快速入门 C# Web API 的开发与应用。