using ASP.NET Core 建立 C# Web 應用程式

運行預設應用程式

Tim 首先運行預設的應用程式，展示開發者預設可獲得的內容。 執行後，專案會構建 API，下載必要的 NuGet 套件，並啟動一個網頁。 這個初始設置在沒有任何修改的情況下展示了 API 的基本結構和功能。

與 API 的互動

啟動的網頁由 Swagger 提供技術支持，現在被稱為 OpenAPI。 Swagger 提供了易於使用的介面來與 API 進行互動。 它允許開發者和非開發者輕鬆地了解和測試 API 的端點。 這個介面特別有利於可視化 API 的工作原理和文件紀錄。

探索 Swagger

Swagger 展示了 API 中可用的端點。 在預設設置中，其中一個預配置的端點是 "天氣預報" 端點。 透過點擊這個端點並使用 "Try it out" 功能，使用者可以執行 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 將資料層從使用者介面中抽象出來，使不同的客戶端應用（移動應用、網頁應用、桌面應用）得以與同一資料源互動，而不需暴露資料庫或其憑證。

不同框架中的多樣性

Tim 指出 API 不限於特定框架或語言。 例如，C# API 可以被 JavaScript 框架如 Angular、React 或 Vue 存取，展示了 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 路由正確配置。 他偏好使用 "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 檢索所有使用者，而 /users/5 檢索具有 ID 5 的特定使用者。

3. REST 合規：Tim 指出完全達到 REST 合規性可能具有挑戰，因為 REST 最初是一種理論模型。 然而，遵循 REST 原則可以導致更直觀和一致的 API。

Tim 強調，儘管建議達到 REST 合規性，但實際上的考量應該引導 API 設計，確保其可用性和功能性。

最小 API 應用程式

Corey 介紹了最小 API，這是一種簡化的 API 開發方式在 ASP.NET Core 中：

1. 設置最小 API：Tim 展示了如何通過設置專案時取消勾選 "使用控制器" 選項來建立最小 API 專案。

2. 簡化程式碼：最小 API 消除了使用控制器和路由屬性的需要，允許開發者直接在 Program.cs 中使用像 app.MapGet(), 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 被設計來簡化開發，特別是對於較小的應用程式或微服務。