自定义域名
xx.apifox.cn
格式的 URL。如果你希望通过使用自有域名 (比如:www.your-domain.com
) 访问 API 在线文档,那么就需要进行 CNAME 配置。CNAME 方式
获取 CNAME 值
添加 CNAME 记录
1.
2.
3.
参数说明 | 填写说明 | 注意事项 |
---|---|---|
主机记录 | 一般是指子域名的前缀 (如需创建子域名为 www.apifox-doc.com ,主机记录输入 www;如需实现 apifox-doc.com,主机记录输入 @ ) | 该参数唯一,请勿自定义 |
记录类型 | 选择 CNAME 类型 | 该参数唯一,请勿自定义 |
线路类型 | 保持默认 | 该参数可以根据需求自行调整 |
记录值 | 从 Apifox 复制过来的 CNAME | 该参数唯一,请勿自定义 |
TTL | 保持默认 | 该参数可以根据需求自行调整 |
启用 HTTPS
SSL 证书
常见问题
自有服务器中转方式
Apifox 版本号需 ≥ 2.2.19。
Web
服务器代理。Web 服务器
Nginx
来代理您的服务从而使用自有服务器中转功能。Nginx
中可以使用 proxy_pass
命令,这个命令用于将请求转发到其他服务器。Nginx
中可以使用 proxy_set_header
命令,这个命令用于设置代理服务器发送给上游服务器的请求头。Nginx
配置文件中添加如下内容来进行简单配置。
{docsSiteId}
为你的文档站 id
,即自定义域名面板显示的 Docs Site ID
,请确保填写正确的 id
。全站加速(CDN)服务
HTTP
头从而来使用自有服务器中转功能。1.
{docsSiteId}.n3.apifox.cn
2.
自定义域名
3.
HTTP
请求头:X-Apifox-Docs-Site-ID
{docsSiteId}
{docsSiteId}
为你的文档站 id
,即自定义域名面板显示的 Docs Site ID
,请确保填写正确的 id
。阿里云
1.
2.
3.
腾讯云
1.
2.
X-Apifox-Project-ID
请求头。七牛云
1.
2.
嵌入至自有域名的子目录
Apifox 版本号需 ≥ 2.5.24。
example.com
)。然后点击 “自有服务器中转”,启用 “使用子目录”,并输入子目录名称 (如:api-docs
)。Nginx
中可以使用 proxy_pass
命令,这个命令用于将请求转发到其他服务器。Nginx
中可以使用 proxy_set_header
命令,这个命令用于设置代理服务器发送给上游服务器的请求头。
/api-docs
为你的自定义域名下的子目录,请根据你的文档地址自行修改,尾部一定要添加斜杠 /
,见上述示例代码。http://{docsSiteId}.n3.apifox.cn
尾部也需添加斜杠 /
,见上述示例代码。{docsSiteId}
为你的文档站 id
,即自定义域名面板显示的 Docs Site ID
,请确保填写正确的 id
。修改于 2025-02-11 09:00:28