VS2022 ASP.NET core Web API 示例代码解释

VS2022 ASP.NET Core Web API 示例代码解释

ASP.NET Core 是一种高性能、跨平台的框架，专为构建现代互联网应用程序而设计，包括 Web 应用和 Web API。在本文中，我们将通过一个简单的示例来说明如何使用 Visual Studio 2022 创建一个 ASP.NET Core Web API，并对示例代码进行详细解释。

创建项目

首先，在 Visual Studio 2022 中创建一个新的项目。选择“ASP.NET Core Web API”，并命名为 SampleApi。保持默认设置，选择 .NET 6.0 作为目标框架，然后创建项目。

项目结构

创建项目后，您将看到以下文件结构：

SampleApi
│
├── Controllers
│   └── WeatherForecastController.cs
│
├── Program.cs
├── Startup.cs
└── SampleApi.csproj

在这里，我们的主要关注点是 Controllers 文件夹中的控制器，以及 Program.cs 文件。

示例代码

接下来，我们将创建一个简单的控制器，响应 HTTP 请求并返回天气预报信息。可以在 Controllers 文件夹中创建一个新的控制器，命名为 SampleController.cs，代码如下：

using Microsoft.AspNetCore.Mvc;

namespace SampleApi.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class SampleController : ControllerBase
    {
        private static readonly string[] Summaries = new[]
        {
            "暴雪", "寒冷", "温暖", "凉爽", "湿润", "风", "微风"
        };

        [HttpGet]
        public IEnumerable<WeatherForecast> Get()
        {
            var rng = new Random();
            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
            {
                Date = DateTime.Now.AddDays(index),
                TemperatureC = rng.Next(-20, 55),
                Summary = Summaries[rng.Next(Summaries.Length)]
            })
            .ToArray();
        }
    }

    public class WeatherForecast
    {
        public DateTime Date { get; set; }
        public int TemperatureC { get; set; }
        public string Summary { get; set; }

        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
    }
}

代码解释

1. 命名空间与引用：我们引用了 Microsoft.AspNetCore.Mvc 命名空间，该命名空间提供了控制器所需的基类型和属性。

2. 控制器类：SampleController 继承自 ControllerBase，表示这是一个 API 控制器。我们使用 [ApiController] 特性，使得它具备了 API 控制器的功能。

3. 路由定义：[Route("[controller]")] 特性定义了控制器的路由。这里，[controller] 将自动替换为控制器的名称，即 Sample，最终路由为 /sample。

4. HTTP GET 方法：[HttpGet] 特性指明下面的方法是用来处理 GET 请求的。Get() 方法返回一个 IEnumerable<WeatherForecast> 类型的集合。

5. 随机数据生成：使用 Random 类生成随机的天气数据。Enumerable.Range(1, 5) 创建一个包含 5 个元素的序列，每个元素产生一条天气预报，包含日期、气温和天气状况。

6. WeatherForecast 类：这是一个简单的数据模型，包含属性 Date、TemperatureC 和 Summary，以及一个计算属性 TemperatureF，用于获取华氏温度。

启动应用

在 Program.cs 文件中，ASP.NET Core 的应用程序配置和启动是在这里进行的。默认代码已经包含了必要的中间件和服务配置，您可以直接运行应用。

在浏览器中访问 http://localhost:<port>/sample 可以看到返回的天气数据。

总结

通过这个简单的示例，我们展示了如何使用 Visual Studio 2022 创建一个基本的 ASP.NET Core Web API。您可以根据具体需求扩展控制器，添加更多的方法和功能。基本的 CRUD 操作、数据持久化和身份验证等功能可以在此基础上进一步实现，以满足日常开发的需求。ASP.NET Core 强大的灵活性和扩展性，使得它成为构建现代 Web 应用和 API 的理想选择。