Swashbuckle.WebApi 使用指南

Swashbuckle.WebApi 是一个用于 .NET WebAPI 项目的工具，它允许你的 API 自动生成 Swagger 文档，并集成 Swagger UI 来提供交互式的 API 探索体验。本教程将指导你了解项目的目录结构、启动文件以及配置文件。

1. 项目目录结构及介绍

在下载并解压 Swashbuckle.WebApi 项目后，你会看到以下主要目录：

Swashbuckle.WebApi/
|-- src/
|   |-- Swashbuckle.AspNetCore/
|   |-- Swashbuckle.AspNetCore.Swagger/
|   |-- Swashbuckle.AspNetCore.SwaggerGen/
|   `-- Swashbuckle.AspNetCore.SwaggerUi/
|-- samples/
`-- tests/
    |-- Swashbuckle.AspNetCore.Samples/
    `-- Swashbuckle.AspNetCore.Tests/

• src/：源代码目录，包含了 Swashbuckle 库的各个组件。

  • Swashbuckle.AspNetCore: 核心库，提供了 Swagger 功能的基础。
  • Swashbuckle.AspNetCore.Swagger: 提供了 Swagger JSON 的生成和暴露功能。
  • Swashbuckle.AspNetCore.SwaggerGen: 自动从路由、控制器和模型生成 Swagger 文档的生成器。
  • Swashbuckle.AspNetCore.SwaggerUi: 内置版本的 Swagger UI 工具，展示交互式文档。

• samples/：示例应用目录，用于演示如何在实际项目中整合 Swashbuckle。

• tests/：测试目录，包括单元测试和样本应用程序的测试。

2. 项目的启动文件介绍

在示例项目（如 samples/Swashbuckle.AspNetCore.Samples）中，启动文件通常是 Startup.cs。在这个文件里，你需要集成 Swashbuckle 到你的 ASP.NET Core 应用程序中。关键部分通常包括两个方法：ConfigureServices 和 Configure。

• ConfigureServices(IServiceCollection services)：在这里注册 Swashbuckle 服务，例如：

  services.AddSwaggerGen(c =>
  {
      c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
  });
  

• Configure(IApplicationBuilder app, IWebHostEnvironment env)：在此设置中间件，使 Swagger 可以通过 HTTP 请求访问，例如：

  app.UseSwagger();
  app.UseSwaggerUI(c => 
  {
      c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
  });
  

上述代码会启用 Swagger JSON 端点（/swagger/v1/swagger.json），并在 Swagger UI 中显示。

3. 项目的配置文件介绍

对于 ASP.NET Core 应用，配置通常存储在 appsettings.json 或其他环境特定的文件（如 appsettings.Development.json）中。不过，在 Swashbuckle 的基本使用情况下，不需要额外的配置文件来设置 Swagger。大部分配置是在 Startup.cs 文件内进行的，就像上文所述的 AddSwaggerGen 和 UseSwaggerUI 方法。

如果你需要自定义 Swagger 行为或添加附加信息，可以考虑在 ConfigureServices 方法内的 AddSwaggerGen 配置块中进行。例如，你可以为模型类型添加 XML 注释，或者定制认证方案：

services.AddSwaggerGen(c =>
{
    // 添加 XML 注释
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);

    // 定制认证方案描述
    c.AddSecurityDefinition("Bearer", new ApiKeyScheme()
    {
        Description = "JWT Authentication",
        Name = "Authorization",
        In = "header",
        Type = "apiKey"
    });
});

到此为止，你应该对 Swashbuckle.WebApi 的核心组件有了一定的理解，也知道如何开始集成和配置它到你的 ASP.NET Core 项目中。通过遵循这些步骤，你可以创建出具有详细文档和测试工具的高质量 Web API。