如何在Redoc中隐藏服务器主机,仅显示API基础路径?
解决Redoc显示API端点时包含主机URL的问题
以下是几个经过验证的有效方案,帮你实现只显示基础路径和端点(比如/v1/abc)的需求:
精准配置OpenAPI的servers字段
不要用空URL或随意配置,直接把server的url设为/,并且确保只保留这一条server配置,避免其他带主机的配置干扰:servers: - url: "/" description: 默认环境配合Redoc的
hideHostname配置项
不管是用Redoc CLI还是React组件,都要显式开启hideHostname选项:- 用Redoc CLI启动时:
redoc-cli serve your-openapi-spec.yaml --options hideHostname=true - 用React组件嵌入时:
<Redoc spec={yourSpecData} options={{ hideHostname: true }} />
- 用Redoc CLI启动时:
处理特殊情况:仍显示浏览器URL
如果上述配置后还是出现浏览器的主机地址,尝试把OpenAPI的servers url设为空字符串,同时保留hideHostname配置:servers: - url: ""排查版本问题
部分旧版本的Redoc存在hideHostname选项不生效的bug,建议升级到最新的稳定版再测试。
内容的提问来源于stack exchange,提问作者Danish Hasan
相关产品推荐
相关产品推荐

