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

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.xdnf.cn/news/681949.html

相关文章:

  • leetcode hot100刷题日记——21.不同路径
  • 六、西方哲学
  • 【连载19】基础智能体的进展与挑战综述-对智能体大脑的威胁
  • halcon高斯滤波
  • 网络编程--上篇
  • 【详细记录】我的第一次裸片硬件尝试:stm32f103c8t6最小核心板一板成
  • unet 视频截图 实现简单的unet kaggle运行
  • Kruskal-Wallis检验 vs. 多次Wilcoxon检验:多重比较-spss
  • LCR 094. 分割回文串 II
  • Elasticsearch搜索机制与分页优化策略
  • Pytest自动化测试框架搭建:Jenkins持续集成
  • 通俗解释网络参数RTT(往返时间)
  • Scratch节日 | 六一儿童节
  • 并发编程(二)—synchronized和volatile
  • 尚硅谷redis7 55-57 redis主从复制之理论简介
  • 从零搭建上门做饭平台:高并发订单系统设计
  • 普罗米修斯监控CPU\内存汇聚图
  • 产业集群间的专利合作关系
  • Visual Studio编译当前文件
  • vue项目 build时@vue-office/docx报错
  • ceph recovery 相关参数
  • MMdetection推理验证输出详解(单张图片demo)
  • 用DEEPSEEK写的扫雷小游戏
  • 如何设计高效的索引策略?
  • 一则doris数据不一致问题
  • Day38 Python打卡训练营
  • Python+OpenCV实战:高效实现车牌自动识别
  • 卷积神经网络(CNN)入门学习笔记
  • 定时清理流媒体服务器录像自动化bash脚本
  • 大模型 Agent 中的通用 MCP 机制详解