Asp.Net Core 如何配置在Swagger中带JWT报文头

文章目录

  • 前言
  • 一、配置方法
  • 二、使用
    • [1、运行应用程序并导航到 /swagger](#1、运行应用程序并导航到 /swagger)
    • [2、点击右上角的 Authorize 按钮。](#2、点击右上角的 Authorize 按钮。)
    • [3、输入 JWT 令牌,格式为 Bearer your_jwt_token。](#3、输入 JWT 令牌,格式为 Bearer your_jwt_token。)
    • [4、后续请求将自动携带 Authorization 头。](#4、后续请求将自动携带 Authorization 头。)
  • 三、注意事项
  • 总结

前言

配置Swagger支持JWT

一、配置方法

  1. 在 Program.cs 的 Swagger 配置部分添加安全定义和需求:

    csharp 复制代码
    builder.Services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    
        // 添加 JWT 认证配置
        var securityScheme = new OpenApiSecurityScheme
        {
            Name = "Authorization",
            Description = "JWT Authorization header using the Bearer scheme.\r\nExample:'Bearer fadffdfadfds'",
            In = ParameterLocation.Header,
            Type = SecuritySchemeType.ApiKey,
            Scheme = "bearer",
            BearerFormat = "JWT",
            Reference = new OpenApiReference
            {
                Type = ReferenceType.SecurityScheme,
                Id = "Authorization"
            }
        };
    
        c.AddSecurityDefinition("Authorization", securityScheme);
    
        var securityRequirement = new OpenApiSecurityRequirement
        {
            { securityScheme, new[] { "Bearer" } }
        };
    
        c.AddSecurityRequirement(securityRequirement);
    });

二、使用

1、运行应用程序并导航到 /swagger

  1. 如下图:

2、点击右上角的 Authorize 按钮。

  1. 如下图:

3、输入 JWT 令牌,格式为 Bearer your_jwt_token。

  1. 如下图:

4、后续请求将自动携带 Authorization 头。

三、注意事项

  • 令牌格式 :输入令牌时确保包含 Bearer 前缀和空格。
  • 作用域配置 :如需更细粒度的控制,可在 AddSecurityRequirement 中指定作用域。
  • 生产环境 :确保在生产环境中使用 HTTPS 并妥善保管密钥。

总结

完成上述配置后,Swagger 将自动在请求头中添加 JWT,方便在开发过程中测试受保护的 API 端点。

相关推荐
绝无仅有42 分钟前
对接三方SDK开发过程中的问题排查与解决
后端·面试·架构
考虑考虑2 小时前
使用jpa中的group by返回一个数组对象
spring boot·后端·spring
GiraKoo2 小时前
【GiraKoo】C++11的新特性
c++·后端
MO2T2 小时前
使用 Flask 构建基于 Dify 的企业资金投向与客户分类评估系统
后端·python·语言模型·flask
光溯星河2 小时前
【实践手记】Git重写已提交代码历史信息
后端·github
PetterHillWater3 小时前
Trae中实现OOP原则工程重构
后端·aigc
圆滚滚肉肉3 小时前
后端MVC(控制器与动作方法的关系)
后端·c#·asp.net·mvc
SimonKing3 小时前
拯救大文件上传:一文彻底彻底搞懂秒传、断点续传以及分片上传
java·后端·架构
深栈解码3 小时前
JUC并发编程 内存布局和对象头
java·后端
37手游后端团队3 小时前
巧妙利用装饰器模式给WebSocket连接新增持久化
后端