Redoc独立HTML页面未显示authentication认证板块问题排查
原因
- 该现象和你的
openapi.yml文件内容无关,你的components/securitySchemes、全局security节点写法完全符合OpenAPI 3.0.3规范,差异来自Redoc的默认配置不同:- 独立HTML中引用的Redoc 2.x最新版本,默认将配置项
hideSecuritySection设为true,即默认隐藏文档顶部的全局Authentication板块,仅在每个API接口条目下单独标注对应接口的鉴权要求 - IntelliJ的OpenAPI Editor插件内置的Redoc修改了该默认配置,将
hideSecuritySection设为false,因此插件预览时可以正常看到全局认证板块
- 独立HTML中引用的Redoc 2.x最新版本,默认将配置项
- 可以排除文件加载失败、跨域等问题:如果是这类问题,整个API文档都无法正常渲染,不会仅缺失认证板块。
修复方式
在<redoc>自定义标签上添加hide-security-section="false"属性,显式关闭安全板块隐藏逻辑即可。
修改后的Redoc元素代码如下:
<redoc spec-url="openapi.yml" hide-security-section="false"></redoc>
注意:HTML标签属性不支持驼峰命名,JS配置中的驼峰字段
hideSecuritySection需要转为短横线分隔的hide-security-section作为属性名,属性值传字符串"false"即可生效。
修改后刷新页面,就能正常渲染<div id="section/authentication">对应的全局认证板块,所有在components/securitySchemes下定义的鉴权方式都会正常展示。
内容的提问来源于stack exchange,提问作者Cephalopod
相关产品推荐
相关产品推荐

