Apifox接口文档自定义域名怎么配置?发布设置详解

裘德小鎮的故事

裘德小鎮的故事

2026-07-09

217人浏览

原创

apifox接口文档走自定义域名必须用「自有服务器中转」模式,因cname方式下apifox cdn强制校验host头与项目绑定关系,导致403错误;需nginx反向代理配置proxy_pass、proxy_set_header host和x-apifox-project-id三项联动,并在apifox后台设置为中转模式、填正确域名及公开权限。

apifox接口文档自定义域名怎么配置?发布设置详解

Apifox 接口文档要走自定义域名,必须用「自有服务器中转」模式,CNAME 方式不支持公开文档发布(会 403)。 直接填域名、点保存是没用的,关键在 Nginx 反向代理配置和 Apifox 后台两个地方联动生效。

为什么 CNAME 不行?

Apifox 公开文档的 CDN 节点强制校验 Host 头和项目绑定关系。CNAME 解析过去后,请求实际发到 Apifox 的 CDN 域名(如 5491021.n3.apifox.cn),但浏览器或客户端带的是你的域名(如 docs.example.com),Apifox 服务端会拒绝响应,返回 403 Forbidden

只有「自有服务器中转」模式允许你用自己的 Nginx 接收请求,再以指定 HostX-Apifox-Project-ID 头转发,才能绕过校验。

Nginx 反向代理必须配对的三项

以下配置缺一不可,顺序和大小写都影响生效:

Apifox(接口调试工具)
Apifox(接口调试工具)

Apifox是一款拥有可视化管理界面的接口开发调试工具,支持接口调试,自动校验数据结构,自动化测试等功能,能够帮助用户更好的测试API,能够有效提高团队的办公效率,有需要的用户欢迎下载使用!功能介绍可视化接口管理方便快捷可视化接口管理,成倍提升团队多人协作效率。支持数据结构(JSON Schema)管理,多接口可复用相同数据结构。接口调试Postman 有的功能,比如环境变量、预执行脚本、后执行脚本、Cookie/Session 全局共享 等功能,Apifox 都有,并且和 Postman 一样高效好用。

下载
  • proxy_pass 必须指向 Apifox 提供的专属文档域名(形如 http://xxx.n3.apifox.cn),不是官网地址
  • proxy_set_header Host 必须设为你自己的自定义域名(如 docs.example.com),不能省略或写错
  • proxy_set_header X-Apifox-Project-ID 必须填你在 Apifox 后台「自定义域名」设置页看到的完整 ID(如 6576754),不是项目 ID 或分享 ID

示例片段(注意 listen 和 server_name 匹配你的域名):

server {
    listen 80;
    server_name docs.example.com;
    location / {
        proxy_pass http://5491021.n3.apifox.cn;
        proxy_set_header Host docs.example.com;
        proxy_set_header X-Apifox-Project-ID 6576754;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

Apifox 后台「自定义域名」设置关键点

这个页面不只是填个域名那么简单,它决定了 Nginx 转发时需要携带的认证头:

  • 「解析方式」必须选「自有服务器中转」,别选 CNAME
  • 「自定义域名」栏填你最终要访问的完整域名(如 docs.example.com),不要带 http://
  • 保存后页面会显示 X-Apifox-Project-ID 值——这就是上一步 Nginx 配置里要用的那个数字,每次新建分享都会变
  • 「文档权限」必须设为「公开发布」,否则即使域名通了也会跳登录页

HTTPS 怎么加?

Apifox 自有证书只支持 CNAME 模式,所以走自有服务器中转时,SSL 必须由你自己的 Nginx 终止:

  • 用 Certbot 或其他工具申请并部署证书到 Nginx
  • listen 80 改成 listen 443 ssl,加上 ssl_certificatessl_certificate_key 指向你的 PEM 文件
  • 建议加一个 listen 80 的 server 块,301 跳转到 HTTPS
  • 别在 Apifox 后台勾选「自动 HTTPS」——它对中转模式无效

真正容易被忽略的,是 X-Apifox-Project-ID 这个头:它不是静态值,每次重新生成分享链接或修改发布设置都会刷新;只要文档重发布,Nginx 配置就得同步更新,否则 404 或 403。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

apifox

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

2023.10.19

2771

3

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

2025.10.17

2171

12

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2025.12.29

3366

9

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

2026.01.19

160

15

Apifox接口调试教程大全
Apifox接口调试教程大全

Apifox接口调试专题覆盖 HTTP 请求发送、请求头、Query参数、Body请求体、Cookie、鉴权、响应校验、前置脚本、后置脚本和接口用例管理,帮助开发和测试人员在同一工具中完成接口调试、问题定位和前后端联调,减少 Postman 与文档工具之间的数据重复维护。

2026.06.23

43

10

Apifox自动化测试教程
Apifox自动化测试教程

Apifox自动化测试专题围绕接口测试场景编排、测试步骤、断言、变量提取、数据驱动、数据库校验、测试报告和 Apifox CLI 持续集成展开,适合测试工程师和研发团队构建 API 回归测试流程,并与 Jenkins、GitLab CI 等流水线结合提升接口质量保障效率。

2026.06.23

60

10

Apifox迁移协作指南
Apifox迁移协作指南

Apifox迁移协作专题覆盖 Swagger、OpenAPI、Postman、YApi、Eolink、Knife4j、HAR 等数据导入导出,讲解团队权限、项目成员、接口变更同步、数据备份、私有化部署和企业协作管理,适合从旧接口工具迁移到 Apifox 的团队规划统一 API 管理平台。

2026.06.24

49

10

Qt Creator按钮响应设置方法
Qt Creator按钮响应设置方法

信号槽是 Qt 开发的核心机制。本专题整理 Qt Creator 中按钮点击、菜单触发、输入变化、窗口事件、自定义信号、自动连接槽函数和手动 connect 写法,帮助用户理解界面控件如何和 C++ 代码联动。

2026.08.05

0

10

Qt Creator新建项目使用教程
Qt Creator新建项目使用教程

本专题整理 Qt Creator 新建项目、打开已有工程、项目模板选择、目录结构、源文件管理、构建目录、运行配置和项目迁移方法,重点解决新手不知道选 qmake 还是 CMake、项目打不开、文件不参与编译等常见问题。

2026.08.05

0

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Apifox CLI官方手册
Apifox CLI官方手册

共0课时 | 0人学习

Apifox下载与安装手册
Apifox下载与安装手册

共0课时 | 0人学习

Apifox官方手册
Apifox官方手册

共0课时 | 0人学习