使用 ASP.NET Core 创建 C# Web 应用程序

运行默认应用程序

Tim 首先运行了默认应用程序，以说明开发人员可以得到什么。 执行时，项目会构建 API、下载必要的 NuGet 软件包并启动网页。 该初始设置展示了 API 的基本结构和功能，未作任何修改。

与 API 的交互

启动的网页由 Swagger（现称为 OpenAPI）提供支持。 Swagger 提供了与 API 交互的用户友好界面。 让开发人员和非开发人员都能轻松理解和测试 API 端点。 该界面尤其有助于直观地了解 API 的工作原理和文档编制目的。

探索 Swagger.

Swagger 展示了 API 中的可用端点。 在默认设置中，"天气预报 "端点是预配置端点之一。 通过点击该端点并使用 "试用 "功能，用户可以执行 API 调用并查看响应。 此响应包括一个 JSON 格式的天气预报，演示了如何从 API 返回数据。

Tim 在 8:32 着重指出，虽然直接从浏览器读取原始 JSON 数据可能具有挑战性，但 Swagger 的文档覆盖使其更易于消化。 文档提供有关端点的详细信息，包括请求方法（GET、POST 等）、返回数据的结构以及任何所需的参数。

JSON 文档和 API 版本

Swagger 还会生成一个 JSON 文件，正如 Tim 在 9:10 所指出的那样，该文件以机器可读的格式记录了 API。 该文档对于需要与 API 交互的其他应用程序至关重要，因为它描述了可用端点、数据模式和预期响应。

Tim 在 9:29 分指出了 API 中版本控制的重要性。默认设置包括一个版本指示器，暗示可能存在多个 API 版本。 版本对于保持向后兼容性至关重要。 当对 API 的更改可能会破坏现有客户端时，拥有多个版本可以让开发人员在不影响现有用户的情况下引入新功能或更改。

API 的目的

Tim 强调，大多数应用程序都围绕数据检索、操作和显示展开。 API 是用户界面和底层数据之间的中介，为数据访问提供了安全高效的手段。 这种集中化是至关重要的，原因有以下几点：

1.安全性：API 提供了一种管理数据访问的安全方法。 移动和客户端应用程序不应直接连接数据库，以避免在客户端代码中嵌入数据库凭据，从而带来重大安全风险。

2.抽象：API 从用户界面中抽象出数据层，使不同的客户端应用程序（移动应用程序、Web 应用程序、桌面应用程序）能够与相同的数据源交互，而无需暴露数据库或其凭据。

在不同框架中的通用性

Tim 指出，API 并不局限于特定的框架或语言。 例如，C# API 可以被 Angular、React 或 Vue 等 JavaScript 框架访问，展示了 API 的跨平台功能。

1.Program.cs 概述

Tim 回顾了 Program.cs，指出它可以构建网络应用程序并配置各种服务，如控制器的依赖注入和 Swagger (OpenAPI)。 在构建和运行应用程序之前，代码会设置必要的服务。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

2.环境配置

Tim解释了环境设置如何在launchSettings.json中配置。 默认环境设置为 "开发"，用于本地测试，启用 Swagger。 在生产中，出于安全考虑，Swagger 通常是禁用的，但可以通过移除开发检查来启用。

{
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "WebApplication": {
      "commandName": "Project",
      "launchBrowser": true,
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

3.HTTPS 重定向和控制器

Tim 指出了 HTTPS 重定向和控制器的映射。 此设置可确保正确配置 API 路由。 他倾向于在 HTTP 请求和响应路由中使用 "api "前缀，以提高清晰度。

4.天气预报控制器

Tim深入探讨了WeatherForecastController.cs，并强调了路由配置。 默认路由是/weatherforecast，可以修改为包含一个"api"前缀。 控制器使用 HTTP GET 获取数据，可以通过指定路由访问这些数据。

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;

    public WeatherForecastController(ILogger<WeatherForecastController> logger)
    {
        _logger = logger;
    }

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

public class WeatherForecast
{
    public DateTime Date { get; set; }

    public int TemperatureC { get; set; }

    public string? Summary { get; set; }
}

using Microsoft.AspNetCore.Mvc;

[ApiController]
[Route("[controller]")]
public class WeatherForecastController : ControllerBase
{
    private static readonly string[] Summaries = new[]
    {
        "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
    };

    private readonly ILogger<WeatherForecastController> _logger;

    public WeatherForecastController(ILogger<WeatherForecastController> logger)
    {
        _logger = logger;
    }

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

public class WeatherForecast
{
    public DateTime Date { get; set; }

    public int TemperatureC { get; set; }

    public string? Summary { get; set; }
}

5.HTTP动词和路由

Tim 解释了 HTTP 动词（GET、POST、PUT、DELETE）如何定义 API 端点。 对于 GET 请求，浏览器会调用控制器中的指定方法。 其他动词需要使用 Postman 等工具进行测试。

REST API

Tim Corey 介绍了 REST（表征状态转移）及其原理：

1.什么是 REST：REST 是一种设计网络应用程序的架构风格。 它依赖于无状态通信，并使用标准 HTTP 方法（GET、POST、PUT、DELETE）执行操作。

2.RESTful 原则：RESTful API 使用 URL 模式来表示资源。 例如，/users/5检索ID为5的特定用户。

3.REST 合规性：Tim 指出，实现完全的 REST 合规性可能具有挑战性，因为 REST 最初只是一种理论模型。 不过，遵循 REST 原则可以使 API 更直观、更一致。

Tim 强调说，在力求符合 REST 标准的同时，应从实际出发指导应用程序接口的设计，以确保可用性和功能性。

最小 API 应用程序

Corey 介绍了 Minimal API，这是一种在 ASP.NET Core 中进行 API 开发的简化方法：

1.设置 Minimal API：Tim 演示了如何通过在设置项目时取消选中 "使用控制器 "选项来创建 Minimal API 项目。

2. 简化代码：Minimal API消除了对控制器和路由属性的需求，允许开发者在app.MapPost()等方法定义端点。

3.代码示例：Tim 提供了一个代码示例，其中一行代码定义了一个端点。 他演示了如何以最少的配置将 GET 请求映射到端点。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapGet("/", () => "Hello World!");

app.Run();

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.Hosting;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapGet("/", () => "Hello World!");

app.Run();

最小化 API 的设计目的是简化开发，尤其是针对小型应用程序或微服务。