docs.example.com
),代替默认的 xx.apifox.cn
地址。xxxxxxx.n1.apifox.cn
xxxxxxx.n2.apifox.cn
xxxxxxx.nx.apifox.cn
参数说明 | 填写说明 | 备注 |
---|---|---|
记录类型 | 选择 CNAME 类型 | 必选 |
主机记录 | 一般是指子域名的前缀 (如需创建子域名为 docs.example.com ,主机记录输入 docs ;如需实现 example.com ,主机记录输入 @ ) | 子域名前缀 |
解析线路 | 保持默认 | 可按需调整 |
记录值 | 粘贴从 Apifox 获取的 CNAME 地址 | 必选 |
TTL | 保持默认 | 可按需调整 |
https://docs.example.com
)来验证文档是否已经可以正常访问。如果页面已正常显示文档内容,说明配置成功,即使 Apifox 界面仍显示“待校验”,也可以忽略提示,刷新项目页面后状态将更新。Apifox 版本号需 ≥ 2.2.19。
Web
服务器代理。Nginx
来代理您的服务从而使用自有服务器中转功能。Nginx
中可以使用 proxy_pass
命令,这个命令用于将请求转发到其他服务器。Nginx
中可以使用 proxy_set_header
命令,这个命令用于设置代理服务器发送给上游服务器的请求头。Nginx
配置文件中添加如下内容来进行简单配置。
{docsSiteId}
为你的文档站 id
,即自定义域名面板显示的 Docs Site ID
,请确保填写正确的 id
。