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

相关推荐
码事漫谈15 小时前
# 2027年,AI终于要开始“干活”了
后端
小满zs16 小时前
Go语言第二十一章(Gin上传文件)
后端·go
JavaGuide18 小时前
Cloudflare 开源的这套神级安全审计 Skill 太好用了!
前端·后端
学长毕设18 小时前
基于SpringBoot社区快递驿站物流配送系统-附源码
java·spring boot·后端
Resean022319 小时前
Spring 源码分析(七)AOP 原理(上):代理的创建
java·后端·spring
Tangq一定可以的19 小时前
Spring AI Advisor 详解 - 给大模型调用加上“切面“,日志/过滤/记忆一键搞定
java·后端·spring
小巫编程室19 小时前
我造了一个 Java 能力包:让 AI 直接调用你的业务代码
java·前端·后端
十有八七19 小时前
手搓 Agent(五):学会翻书——RAG,先查资料再回答
前端·人工智能·后端
Swot20 小时前
产品 RAG 知识库与 AI 顾问 设计与实现
前端·后端
深入云栈20 小时前
Netty 4.2.x 源码深度解析 (二十四):池化内存分配 —— PoolArena、PoolChunk 与 PoolSubpage
java·后端·架构