Redoc UI如何配置实现接口标签按字母顺序排序
Redoc UI 实现标签字母升序排序的配置方案
Redoc 原生内置了对应能力,无需二次开发改造,通过单个配置项即可实现和Swagger UI tagsSorter: "alpha" 完全一致的标签排序效果。
核心配置说明
控制标签排序的专属参数为 sortTagsAlphabetically,类型为布尔值:
- 设为
true时,所有展示的标签会自动按名称的字典序(A-Z)升序排列 - 不设置或设为
false时,标签按OpenAPI定义里的声明顺序、或接口路径下标签的首次出现顺序展示
不同部署场景的配置方法
1. CDN引入的独立Redoc页面场景
如果是通过<redoc>自定义标签直接嵌入页面的使用方式,把配置写到对应属性里即可:
<redoc spec-url="your-swagger-interface.json" options="{ sortTagsAlphabetically: true }" > </redoc>
如果是通过JS初始化Redoc实例的方式,直接把参数加到初始化配置中:
Redoc.init('your-swagger-interface.json', { sortTagsAlphabetically: true, // 保留原有其他配置项 })
配置生效后,原本无序展示的Messages、Filters、Alarms标签,会自动调整为Alarms → Filters → Messages的升序排列,和预期效果完全匹配。
2. 前端项目嵌入Redoc组件场景
在React等前端项目中引入Redoc组件时,直接给组件传入对应参数即可:
import Redoc from 'redoc'; <Redoc spec={yourParsedSwaggerJson} sortTagsAlphabetically={true} // 保留原有组件传参 />
注意事项
- 如果你的Swagger JSON文件在顶层
tags字段已经手动定义了固定的标签展示顺序,sortTagsAlphabetically配置不会覆盖你手动定义的数组顺序,仅在标签无固定顶层定义、顺序零散时触发升序排序逻辑 - 如果使用的Redoc版本低于v2.0.0正式版,没有内置该配置项,可以在JSON加载完成后,先对
tags数组做一次本地字典排序,再将排序后的JSON传给Redoc渲染,同样能达到排序效果
内容的提问来源于stack exchange,提问作者Seethapriyanka Peddada
相关产品推荐
相关产品推荐

