You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何配置Redocly API文档,允许用户自定义测试服务器地址?

解决Redocly Try It功能中自定义全局服务器URL的问题

Redocly默认不会像Swagger UI那样自动渲染可编辑的服务器变量输入框,但可以通过以下两种方式实现需求:

方法1:在OpenAPI文档中添加Redocly专属扩展

直接在服务器变量配置里加上x-redocly-editable: true标记,让Redocly识别并渲染输入框:

servers:
  - url: https://{baseURL}
    variables:
      baseURL:
        default: defaultserver.aws.com
        description: Enter your server URL (e.g., `api.yourdomain.com`)
        x-redocly-editable: true

方法2:通过Redocly配置文件全局启用

如果需要让所有服务器变量都支持编辑,可以在redocly.yaml配置文件中添加主题设置:

theme:
  tryIt:
    serverVariables:
      editable: true

注意事项

  • 确保使用的是最新版本的Redocly免费托管服务,旧版本可能不支持该功能;
  • 检查OpenAPI 3.0.0文档的语法正确性,语法错误可能导致功能失效;
  • 修改完成后,重新上传文档或配置文件到Redocly托管平台,刷新页面即可生效。

内容的提问来源于stack exchange,提问作者maat2405

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.13 03:55:57