C#项目中引用Swagger的详细步骤和配置方式

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

public void ConfigureServices(IServiceCollection services)
{
    // 其他服务配置...

    // 添加Swagger生成器服务
    services.AddSwaggerGen(c =>
    {
        // 定义Swagger文档信息
        c.SwaggerDoc("v1", new OpenApiInfo
        {
            Version = "v1",
            Title = "Your API Title",
            Description = "Your API description",
            TermsOfService = new Uri("https://example.com/terms"),
            Contact = new OpenApiContact
            {
                Name = "Contact Name",
                Email = "contact@example.com",
                Url = new Uri("https://example.com/contact")
            },
            License = new OpenApiLicense
            {
                Name = "License Name",
                Url = new Uri("https://example.com/license")
            }
        });

        // 配置XML注释文件路径，以便在Swagger文档中显示方法注释等信息
        var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
        var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
        c.IncludeXmlComments(xmlPath);

        // 如果你的API有身份验证等安全机制，可以在这里配置
        c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
        {
            In = ParameterLocation.Header,
            Description = "Please enter JWT with Bearer prefix",
            Name = "Authorization",
            Type = SecuritySchemeType.ApiKey
        });
        c.AddSecurityRequirement(new OpenApiSecurityRequirement
        {
            {
                new OpenApiSecurityScheme
                {
                    Reference = new OpenApiReference
                    {
                        Type = ReferenceType.SecurityScheme,
                        Id = "Bearer"
                    }
                },
                new string[] {}
            }
        });
    });
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // 其他中间件配置...

    // 启用Swagger
    app.UseSwagger();

    // 启用Swagger UI，指定Swagger JSON文档的路由
    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API v1");
        // 如果需要，可以配置Swagger UI的其他选项，如文档展开深度等
        c.DocExpansion(DocExpansion.None);
    });
}

/// <summary>
/// 获取用户信息
/// </summary>
/// <param name="id">用户ID</param>
/// <returns>用户信息对象</returns>
[HttpGet("{id}")]
public IActionResult GetUser(int id)
{
    // 方法实现
}

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

// 添加Swagger生成器服务
services.AddSwaggerGen(c =>
{
    // 其他Swagger配置...

    // 添加JWT Bearer安全定义
    c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
    {
        // 定义安全机制的类型为API密钥
        Type = SecuritySchemeType.ApiKey,
        // 说明该密钥位于请求头中
        In = ParameterLocation.Header,
        // 请求头中用于传递JWT令牌的字段名称
        Name = "Authorization",
        // 对该安全定义的描述，在Swagger UI中会显示给用户
        Description = "请输入带有Bearer前缀的JWT令牌"
    });

    // 添加安全要求，指定使用Bearer安全定义的API需要进行身份验证
    c.AddSecurityRequirement(new OpenApiSecurityRequirement
    {
        {
            new OpenApiSecurityScheme
            {
                // 引用前面定义的Bearer安全定义
                Reference = new OpenApiReference
                {
                    Type = ReferenceType.SecurityScheme,
                    Id = "Bearer"
                }
            },
            // 这里可以指定一些额外的作用域或权限，如果不需要可以留空数组
            new string[] { }
        }
    });
});

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

// 添加Swagger生成器服务
services.AddSwaggerGen(c =>
{
    // 其他Swagger配置...

    // 添加API密钥安全定义
    c.AddSecurityDefinition("ApiKey", new OpenApiSecurityScheme
    {
        // 定义安全机制的类型为API密钥
        Type = SecuritySchemeType.ApiKey,
        // 说明该密钥位于请求头中
        In = ParameterLocation.Header,
        // 请求头中用于传递API密钥的字段名称
        Name = "X-Api-Key",
        // 对该安全定义的描述，在Swagger UI中会显示给用户
        Description = "请输入你的API密钥"
    });

    // 添加安全要求，指定使用ApiKey安全定义的API需要提供有效的API密钥
    c.AddSecurityRequirement(new OpenApiSecurityRequirement
    {
        {
            new OpenApiSecurityScheme
            {
                // 引用前面定义的ApiKey安全定义
                Reference = new OpenApiReference
                {
                    Type = ReferenceType.SecurityScheme,
                    Id = "ApiKey"
                }
            },
            // 这里可以指定一些额外的作用域或权限，如果不需要可以留空数组
            new string[] { }
        }
    });
});