如何通过Redocly自定义HTML输出以隐藏版本号?
解决方案
Redocly支持通过主题配置或构建参数,实现保留合规info.version的前提下,隐藏HTML文档头部的版本号,具体方法如下:
使用主题配置文件隐藏版本号
创建一个主题配置文件(例如custom-theme.yaml),添加以下配置关闭版本号显示:header: version: display: false执行构建命令时指定该主题文件:
redocly build-docs your-openapi.yaml -o output.html --theme custom-theme.yaml在全局配置文件中设置
如果项目已有redocly.yaml,直接在其中添加主题配置即可:theme: header: version: display: false后续执行
redocly build-docs时会自动读取该配置,生成的HTML将不再显示版本号。临时构建时覆盖版本号
若不想修改配置文件,可在构建命令中通过--template-options临时将版本号设为空,达到隐藏效果:redocly build-docs your-openapi.yaml -o output.html --template-options '{"info": {"version": ""}}'这种方式适合沙箱环境等临时场景,无需改动原OpenAPI文件和主题配置。
内容的提问来源于stack exchange,提问作者Evan Carroll
相关产品推荐
相关产品推荐

