使用 SwaggerGen 添加服务未在 .NET Core 中获取信息

Swagger 是一个用于构建、文档化和可视化 RESTful API 的开源工具。SwaggerGen 是 Swagger 提供的一个生成器，用于在 .NET Core 项目中自动生成 Swagger 文档。本文将介绍如何在 .NET Core 项目中使用 SwaggerGen 添加未在项目中获取到的服务信息。

步骤 1: 添加 SwaggerGen NuGet 包

首先，需要在你的 .NET Core 项目中添加 SwaggerGen NuGet 包。在 Visual Studio 中，可以通过以下步骤完成：

1. 在“解决方案资源管理器”中右键点击你的项目，选择“管理 NuGet 包...”。
2. 在“NuGet 包管理器”窗口中，选择“浏览”选项卡。
3. 在搜索框中输入“Swashbuckle.AspNetCore.SwaggerGen”，点击“安装”按钮以安装包。

或者，如果使用 dotnet 命令行工具，可以运行以下命令：

dotnet add package Swashbuckle.AspNetCore.SwaggerGen

步骤 2: 添加 SwaggerGen 配置

完成包的安装后，需要在 Startup.cs 文件的 ConfigureServices 方法中添加 SwaggerGen 的配置。打开 Startup.cs 文件，在 ConfigureServices 方法中添加以下代码：

using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;

public void ConfigureServices(IServiceCollection services)
{
    // 添加 SwaggerGen
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    });
}

以上代码将在服务集合中添加 SwaggerGen，并指定了 Swagger 文档的标题和版本。你可以根据需要自定义这些值。

步骤 3: 启用 SwaggerGen 中间件

最后一步是在 Startup.cs 文件的 Configure 方法中启用 SwaggerGen 中间件，以便在应用程序中提供 Swagger 文档。在 Configure 方法中添加以下代码：

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

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // ...

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

    // ...
}

以上代码将在应用程序中注册了 Swagger 中间件，并指定了 Swagger UI 页面的访问路径和 Swagger 文档的地址。

结论

通过以上步骤，你已经成功地在 .NET Core 项目中使用 SwaggerGen 添加了未在项目中获取到的服务信息。现在，你可以重新编译和运行项目，并在浏览器中访问 Swagger UI 页面，查看并测试 API 文档。

以上是使用 SwaggerGen 添加服务未在 .NET Core 中获取信息的介绍。希望对你有帮助！