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 端点。

相关推荐
Victor35632 分钟前
MySQL(161)MySQL如何实现锁机制?
后端
Victor35636 分钟前
MySQL(162)MySQL中的行级锁和表级锁有什么区别?
后端
周末程序猿1 小时前
技术总结|如何使用提升 strlen 的性能?
后端·算法
tang_jian_dong1 小时前
springboot + vue3 拉取海康视频点位及播放
spring boot·后端·音视频
程序员爱钓鱼2 小时前
Go语言实战案例-括号匹配算法
后端·google·go
程序员爱钓鱼2 小时前
Go语言实战案例-判断字符串是否由另一个字符串的字母组成
后端·google·go
郝学胜-神的一滴4 小时前
SpringBoot实战指南:从快速入门到生产级部署(2025最新版)
java·spring boot·后端·程序人生
王柏龙7 小时前
Asp.net core mvc中TagHelper的GetChildContentAsync和Content区别
mvc·.netcore
爷_8 小时前
字节跳动震撼开源Coze平台!手把手教你本地搭建AI智能体开发环境
前端·人工智能·后端
不过普通话一乙不改名12 小时前
第一章:Go语言基础入门之函数
开发语言·后端·golang