展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > C#怎么实现Swagger认证配置 C#如何在Swagger UI中添加JWT Bearer Token认证输入框【框架】

C#怎么实现Swagger认证配置 C#如何在Swagger UI中添加JWT Bearer Token认证输入框【框架】

SwaggerUI不显示Authorization按钮源于未注册JWTBearer方案,需在AddSwaggerGen中同时配置AddSecurityDefinition(scheme小写bearer)和AddSecurityRequirement,且认证中间件UseAuthentication与UseAuthorization须置于UseSwaggerUI

本文目录

    其实,Swagger UI 上不显示 Authorization 按钮,根本原因就是配置没到位。具体来说,需要在 AddSwaggerGen 中同时配置 AddSecurityDefinition(注意 scheme 必须小写 bearer)和 AddSecurityRequirement。另外,认证中间件 UseAuthentication 和 UseAuthorization 必须放在 UseSwaggerUI 之前,控制器上还要加上 [Authorize] 特性,这样 Swagger 才能正确识别并显示按钮。下面逐一拆解这些常见问题。

    C#怎么实现Swagger认证配置 C#如何在Swagger UI中添加JWT Bearer Token认证输入框【框架】

    Swagger UI 里没出现 Authorization 按钮,Authorize 按钮不显示

    为什么按钮没出现?说白了,就是 Swagger 文档生成时没注册 JWT Bearer 方案。Swashbuckle 不会自动猜你用了 JWT,必须显式声明 AddSecurityDefinition 和 AddSecurityRequirement。

    具体操作时,在 Program.cs(.NET 6+)中配置两处:

    • 在 builder.Services.AddEndpointsApiExplorer() 之后,调用 AddSwaggerGen 时传入配置委托。
    • 必须同时定义 SecurityScheme:类型选 SecuritySchemeType.Http,scheme 设为 bearer(注意是小写),bearerFormat 建议设为 JWT。
    • 还要在每个 API 描述里注入 SecurityRequirement,否则按钮只显示、不生效。

    漏掉任意一个环节,Authorize 按钮都不会出现。最常见的错误是只加了 scheme 却忘了 AddSecurityRequirement,或者把 scheme 写成了大写开头的 Bearer——OpenAPI 规范只认小写 bearer,差一点都不行。

    .NET 6+ Program.cs 中 JWT 认证配置顺序错乱导致 401 或文档不加载

    配置顺序是个容易出错的细节。Swagger 要求认证中间件、授权策略和文档生成三者顺序严格对齐。最常踩的坑是:在 app.UseSwaggerUI() 前没调用 app.UseAuthentication() 和 app.UseAuthorization(),或者反过来把 AddJwtBearer 放在了 AddSwaggerGen 后面。

    正确的顺序是:

    • AddAuthentication().AddJwtBearer() → 先注册认证方案。
    • AddAuthorization() → 再注册默认策略(比如 options.DefaultPolicy = new AuthorizationPolicyBuilder().RequireAuthenticatedUser().Build();)。
    • AddEndpointsApiExplorer() + AddSwaggerGen() → 此时才能引用前面定义的 scheme 名。
    • UseAuthentication() 和 UseAuthorization() 必须紧挨着 UseRouting(),并且放在 UseSwaggerUI() 之前。

    顺序错一个位置,Swagger 页面可能出现空白,控制台报 Failed to load API definition,或者点击 Authorize 后调用接口仍然返回 401——实际原因是请求根本没进入认证中间件。

    点击 Authorize 输入 token 后,所有接口仍带空 Authorization 头

    这个问题其实在前端,不是后端配置失败。Swagger UI 默认不会自动把 token 注入到每个请求头,除非你明确告诉它哪些接口需要认证。

    所以,必须在控制器或方法上加 [Authorize] 特性,并确保 Swashbuckle 能识别这个标记。关键是在 AddSwaggerGen 配置中,要启用 DocInclusionPredicate 并正确处理 AuthorizeAttribute,否则即使加了特性,Swagger 也不会给对应接口添加 security 字段。

    推荐做法是在 AddSwaggerGen 委托中加入以下配置:

    options.AddSecurityRequirement(new OpenApiSecurityRequirement{    {        new OpenApiSecurityScheme        {            Reference = new OpenApiReference { Type = ReferenceType.SecurityScheme, Id = "Bearer" }        },        new string[] { }    }});

    注意,这里的 Id = "Bearer" 必须和前面 AddSecurityDefinition("Bearer", ...) 的第一个参数完全一致,大小写敏感,否则关联断裂,token 就不会被带上。

    Swagger UI 发送请求时 token 被截断或含换行,导致 401

    这种情况挺常见的。用户手动粘贴 token 到弹窗时,容易带进一些不可见字符,比如从某些 JWT 网站复制时附带的 \r\n。Swagger UI 不会自动清洗,直接拼进 Authorization: Bearer xxx 头里,后端 JwtBearerHandler 解析自然失败。

    这不算代码 bug,但很影响调试效率。建议:

    • 在开发环境加个简单日志:在 Program.cs 的 AddJwtBearer 配置里,设置 Events.OnAuthenticationFailed 打印原始 token 长度和前 20 个字符,快速判断是否截断。
    • 提醒测试人员粘贴后手动删掉首尾空格,或者用 Base64 解码工具验证 token 是否合法。
    • 不推荐在生产环境绕过校验,但开发阶段可以临时加 TokenValidationParameters.ValidateLifetime = false 排除过期干扰。

    真正上线时,前端应该通过登录接口获取 token 后存入内存变量,由 Axios 或 Fetch 自动注入 header。Swagger UI 只是调试工具,不该承担 token 管理职责。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 C#
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirServer Windows版
    AirServer Windows版

    AirServer Windows版可把电脑变成AirPlay、Google Cast和Miracast无线投屏接收端,适合会议演示、课堂教学及家庭大屏分享。发送设备通常无需另装客户端,并可同时接收和智能排列多个镜像会话。