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

相关推荐
catchadmin1 小时前
PHP 快速集成 ChatGPT 用 AI 让你的应用更聪明
人工智能·后端·chatgpt·php
callJJ5 小时前
从 0 开始理解 Spring 的核心思想 —— IoC 和 DI(2)
java·开发语言·后端·spring·ioc·di
你的人类朋友7 小时前
JWT的组成
后端
北风朝向8 小时前
Spring Boot参数校验8大坑与生产级避坑指南
java·spring boot·后端·spring
canonical_entropy8 小时前
一份关于“可逆计算”的认知解码:从技术细节到哲学思辨的完整指南
后端·低代码·deepseek
趙卋傑9 小时前
项目发布部署
linux·服务器·后端·web
数据知道10 小时前
Go基础:Go语言能用到的常用时间处理
开发语言·后端·golang·go语言
不爱编程的小九九10 小时前
小九源码-springboot048-基于spring boot心理健康服务系统
java·spring boot·后端
龙茶清欢10 小时前
Spring Boot 应用启动组件加载顺序与优先级详解
java·spring boot·后端·微服务
2351611 小时前
【LeetCode】3. 无重复字符的最长子串
java·后端·算法·leetcode·职场和发展