使用.NET Core3.0的JWT身份验证和Swagger

基础概念

JWT（JSON Web Token） 是一种开放标准（RFC 7519），用于在网络应用间安全地传输信息。它是一种紧凑且自包含的方式，用于在各方之间安全地传输信息。

Swagger 是一个规范和完整的框架，用于描述、生成、消费和可视化RESTful Web服务。它使客户端和服务器的更新同步变得简单，彻底改变了API的设计、开发和测试方式。

优势

JWT身份验证：
- 无状态：服务器不需要存储会话信息，减轻了服务器的负担。
- 安全性：JWT可以通过签名来验证消息的完整性。
- 跨域支持：JWT可以很容易地在不同的域之间传递。
Swagger：
- API文档化：自动生成API文档，方便开发者理解和使用。
- 交互性：提供交互式的API文档，可以直接在浏览器中进行测试。
- 设计一致性：通过Swagger规范，可以确保API的设计一致性。

类型

JWT身份验证类型：
- 访问令牌：用于访问资源。
- 刷新令牌：用于在访问令牌过期后获取新的访问令牌。
Swagger文档类型：
- OpenAPI规范：Swagger基于OpenAPI规范生成文档。
- API Blueprint：另一种用于描述API的格式。

应用场景

JWT身份验证：
- 单点登录（SSO）系统。
- 微服务架构中的身份验证。
- 移动应用和Web应用的身份验证。
Swagger：
- API的设计和开发阶段。
- API的测试和调试。
- API的文档化和发布。

问题及解决方案

问题：JWT令牌过期

原因：JWT令牌有一个过期时间，一旦超过这个时间，令牌就会失效。

解决方案：

在客户端存储刷新令牌，并在访问令牌过期时使用刷新令牌获取新的访问令牌。
示例代码：

public async Task<IActionResult> RefreshToken()
{
    var refreshToken = Request.Cookies["refresh_token"];
    if (refreshToken == null)
    {
        return Unauthorized();
    }

    // 验证刷新令牌并生成新的访问令牌
    var newAccessToken = await _authService.RefreshTokenAsync(refreshToken);
    if (newAccessToken == null)
    {
        return Unauthorized();
    }

    // 设置新的访问令牌到响应中
    Response.Cookies.Append("access_token", newAccessToken, new CookieOptions
    {
        Expires = DateTime.UtcNow.AddMinutes(30)
    });

    return Ok();
}

参考链接：JWT官方文档

问题：Swagger文档未正确显示

原因：可能是由于Swagger配置不正确或依赖项缺失。

解决方案：

确保已安装Swashbuckle.AspNetCore包。
在Startup.cs中正确配置Swagger。
示例代码：

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

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
        app.UseSwagger();
        app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"));
    }

    app.UseRouting();
    app.UseAuthorization();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}