C#中間件與Swagger文檔生成

在C#中，中間件（Middleware）是一種處理請求和響應的組件，它位于應用程序管道中，用于在請求到達應用程序之前或響應返回給客戶端之前對其進行處理。Swagger是一個API文檔生成工具，可以自動生成RESTful API的文檔，方便開發者查看和測試接口。

要在C#項目中使用Swagger文檔生成，你需要安裝Swashbuckle.AspNetCore NuGet包。以下是如何在ASP.NET Core項目中集成Swagger文檔生成的步驟：

1. 安裝Swashbuckle.AspNetCore NuGet包：

dotnet add package Swashbuckle.AspNetCore

2. 在Startup.cs文件中配置Swagger：

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.OpenApi.Models;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 添加Swagger服務
        services.AddSwaggerGen(options =>
        {
            options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
        });

        // 其他服務配置...
    }

    public void Configure(IApplicationBuilder app)
    {
        // 啟用Swagger中間件
        app.UseSwagger();

        // 啟用Swagger UI中間件
        app.UseSwaggerUI(options =>
        {
            options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
        });

        // 其他中間件配置...
    }
}

3. 在控制器中添加Swagger注釋：

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

[ApiController]
[Route("api/[controller]")]
public class ValuesController : ControllerBase
{
    [HttpGet]
    [SwaggerOperation(Summary = "獲取所有值", Description = "返回一個包含所有值的列表")]
    [ProducesResponseType(typeof(IEnumerable<string>), 200)]
    public IActionResult Get()
    {
        return Ok(new[] { "value1", "value2" });
    }
}

現在，當你運行應用程序并訪問/swagger路徑時，你將看到Swagger UI，其中顯示了你的API文檔。你可以查看和測試API接口，而無需編寫任何額外的代碼。