当前位置: 首页 > article >正文

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

文章目录

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


前言

配置Swagger支持JWT

一、配置方法

  1. 在 Program.cs 的 Swagger 配置部分添加安全定义和需求:
    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 端点。

http://www.lryc.cn/news/2394545.html

相关文章:

  • 第12讲、Odoo 18 权限控制机制详解
  • 8086 处理器 Flags 标志位全解析:CPU 的 “晴雨表” 与 “遥控器”总结:
  • 具有离散序列建模的统一多模态大语言模型【AnyGPT】
  • PHP HTTP 完全指南
  • 物流项目第九期(MongoDB的应用之作业范围)
  • 系统思考:经营决策沙盘
  • [网页五子棋][对战模块]实现游戏房间页面,服务器开发(创建落子请求/响应对象)
  • 数据结构-代码总结
  • 快速掌握 GO 之 RabbitMQ
  • SQL Server 事务详解:概念、特性、隔离级别与实践
  • MAC软件游戏打开提示已损坏
  • React基础教程(13):路由的使用
  • 力扣刷题(第四十三天)
  • Centos环境下安装/重装MySQL完整教程
  • 【Linux】环境变量完全解析
  • 【Java】mybatis-plus乐观锁-基本使用
  • 力扣每日一题——找到离给定两个节点最近的节点
  • 机器学习与深度学习03-逻辑回归01
  • 卷积神经网络(CNN)入门学习笔记
  • 【优笔】基于STM32的多模态智能门禁系统
  • Metasploit工具使用详解(上)丨小白WEB安全入门笔记
  • Femap许可证与网络安全策略
  • VLAN的作用和原理
  • 深入探讨集合与数组转换方法
  • 让大模型看得见自己的推理 — KnowTrace结构化知识追踪
  • 【HarmonyOS 5应用架构详解】深入理解应用程序包与多Module设计机制
  • 【Oracle】DCL语言
  • MySQL强化关键_017_索引
  • stm32——SPI协议
  • Linux 下如何查看进程的资源限制信息?