Apifox 帮助文档
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
帮助文档常见问题Apifox 官网私有化部署
开发者中心
  • 开放 API
  • 更新日志
  • Road Map
  • Apifox Markdown
下载
  • 下载 Apifox
  • 下载 IDEA 插件
  • 下载浏览器扩展
  • Apifox Web 版
  1. 发布 API 文档
  • 帮助中心
  • 更新日志
  • 入门
    • 产品介绍
    • 联系我们
    • 私有化部署
  • 开始使用
    • 下载 Apifox
    • 注册与登录
    • 页面布局
    • 基本概念
    • 快速上手
      • 概述
      • 新建接口
      • 发送接口请求
      • 快捷请求
      • 添加断言
      • 新建测试场景
      • 分享 API 文档
      • 了解更多
    • 基础知识
      • 接口基本信息
        • 请求 URL 与方法
        • 请求参数与请求体
        • 请求头
        • 请求参数编码解码
        • HTTP/2
      • 认证与授权
        • 概述
        • 支持的授权类型
        • Digest Auth
        • OAuth 1.0
        • OAuth 2.0
        • Hawk Authentication
        • Kerberos
        • NTLM
        • Akamai EdgeGrid
        • CA 和客户端证书
      • 响应与 Cookie
        • 概述
        • API 响应
        • 创建和发送 Cookie
        • 实际请求
        • 提取响应示例
      • 请求代理
        • 网页端中的请求代理
        • 分享文档中的请求代理
        • 客户端中的请求代理
      • API Hub
        • API Hub
    • 导入导出数据
      • 概述
      • 手动导入
      • 定时导入
      • 导入设置
      • 导出数据
      • 其它方式导入
        • 导入 OpenAPI/Swagger
        • 导入 Postman
        • 导入 Apipost
        • 导入 Eolink
        • 导入 cURL
        • 导入 Markdown
        • 导入 Insomnia
        • 导入 apiDoc
        • 导入 .har 文件
        • 导入 knife4j
        • 导入 NEI
        • 导入小幺鸡(docway)
        • 导入 Apizza
        • 导入 WSDL
  • 设计 API
    • 概述
    • 接口的组织方式
    • 模块
    • 接口基础知识
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 批量管理
    • 数据模型
      • 概述
      • 新建数据模型
      • 构建数据模型
      • 通过 JSON 等生成
      • 高级数据类型
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 全局/环境/临时变量
      • 环境管理
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • MySQL
        • MongoDB
        • Redis
        • Oracle
      • 使用脚本
        • 概述
        • 前置脚本
        • 后置脚本
        • 公共脚本
        • pm 脚本 API
        • 使用 JS 类库
        • 响应数据可视化
        • 调用外部程序
      • 脚本示例
        • 断言示例
        • 脚本使用变量
        • 脚本读取/修改接口请求信息
      • 常见问题
        • 如何获取动态参数的真实值并加密?
        • 脚本运行后,提取的数字(bigint)精度丢失应该如何处理?
    • API 调试
      • GraphQL 调试
      • WebSocket 调试
      • Socket.IO 调试
      • SSE 调试
      • SOAP/WebService
      • gRPC 调试
      • 使用请求代理调试
      • Dubbo 调试
        • 新建 Dubbo 接口
        • 调试 Dubbo 接口
        • Dubbo 接口文档
      • TCP(Socket)
        • Socket 接口功能简介
        • 报文数据处理器
  • Mock 数据
    • 概述
    • 智能 Mock
    • 自定义 Mock
    • Mock 优先级
    • Mock 脚本
    • 云端 Mock
    • 自托管 Runner Mock
  • 自动化测试
    • 概述
    • 编排测试场景
      • 新建测试场景
      • 测试步骤间传递数据
      • 测试流程控制条件
      • 从接口/用例同步数据
      • 跨项目导入接口/用例
      • 导出测试场景数据
    • 运行测试场景
      • 运行测试场景
      • 批量运行测试场景
      • 数据驱动测试
      • 定时任务
      • 管理其它项目接口的运行环境
    • 测试报告
      • 测试报告
    • API 测试
      • 性能测试
      • 集成测试
      • 端到端测试
      • 回归测试
    • Apifox CLI
      • 概述
      • 安装和运行 CLI
      • CLI 命令选项
    • CI/CD
      • 概述
      • 与 Jenkins 集成
      • 与 Gitlab 集成
      • 与 Github Actions 集成
      • 与其它更多 CI/CD 平台集成
      • Git 提交自动触发测试
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义页面代码
    • 自定义域名
    • AI 相关特性
    • SEO 设置
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 功能简介
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 成员角色与权限设置
      • 团队基本操作
      • 团队成员管理
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox AI 功能
    • 总览
    • 启用 AI 功能
    • 修改数据模型
    • 常见问题
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
    • Apifox 测试步骤之间怎么传递数据?
  • 账号&应用设置
    • 账号设置
    • API 访问令牌
    • 语言设置
    • 快捷键
    • 网络代理
    • 数据备份与恢复
    • 更新 Apifox
    • 实验性功能
  • 身份验证 & Auth 鉴权指南
    • 什么是 API Key
    • 什么是 Bearer Token
    • 什么是 JWT
    • 什么是 Basic Auth
    • 什么是 Digest Auth
    • 什么是 OAuth 1.0
    • 什么是 OAuth 2.0
      • 什么是 OAuth 2.0
      • 授权码授权类型
      • 授权码授权类型,带有 PKCE
      • 隐式授权类型
      • 密码凭证授权类型
      • 客户端凭证授权类型
  • 服务与隐私协议
    • 服务协议
    • 隐私协议
    • 服务等级协议
  • 参考资料
    • API 设计优先理念
    • JSON Schema 介绍
    • JSONPath 介绍
    • XPath 介绍
    • Apifox Markdown 语法
    • CSV 格式规范
    • 正则表达式
    • 安装 Java 环境
    • Runner 运行环境
    • 常见编程语言对应的数据类型
    • Socket 粘包和分包问题
    • 词汇表
    • Apifox Swagger 扩展
      • 概述
      • x-apifox-folder
      • x-apifox-status
      • x-apifox-name
      • x-apifox-maintainer
    • Apifox JSON Schema 扩展
      • 概述
      • x-apifox-mock
      • x-apifox-orders
      • x-apifox-enum
    • 动态值表达式
  • 常见问题
  1. 发布 API 文档

自定义页面代码(HTML / CSS / JS)

你可以在发布 API 文档时,自定义添加全局的 HTML、CSS 和 JavaScript 代码,实现页面的个性化样式调整与功能扩展。
该功能适用于以下场景:
嵌入第三方服务(如聊天机器人、AI 智能问答助手)
修改默认样式(如字体、颜色、背景)
添加额外的页面交互(如按钮、动态提示、快捷反馈)
合理使用这项功能,可以让文档更贴近你的品牌风格,也能增强用户的阅读与互动体验。

CSS#

通过添加自定义 CSS,你可以修改页面字体、隐藏元素、调整边距、改变颜色等等。
由于文档页面结构可能在后续迭代中发生调整,为了保证你的样式持续有效,建议遵循以下两条原则:
1.
使用保留的 CSS 变量
2.
使用保留的 CSS 类名

使用保留的 CSS 变量#

Apifox 提供了一批以 --g- 开头的 CSS 变量,用于控制字体、颜色、背景等页面基础样式。这些变量在浅色或深色模式下都具备良好适配性,使用它们可以提升自定义样式的稳定性和可维护性。
常见变量参考
示例:修改主文本颜色

使用保留的 CSS 类名#

如果你需要针对特定区域调整样式,可以使用 Apifox 预留的 .g- 前缀类名,这些类名相对稳定,不容易因 DOM 结构变化而失效。
常见 CSS 类参考
示例:隐藏左侧目录栏

查看页面结构和类名#

除了上面提到的保留的 CSS 变量和类名,你也可以通过浏览器的开发者工具,查找你想修改的页面元素对应的 class 名称,然后写 CSS 来调整样式。
建议优先使用 .g- 开头的类名,这些是平台保留的,结构相对稳定,不容易失效。对于其他结构类名,请谨慎使用,避免产品升级后样式失效。
你可以在浏览器中打开已发布的文档站,使用开发者工具(开发者模式 / 控制台)查看页面结构和样式类名:
Mac:按下 Command + Option + I或fn + F12
Windows:按下 Ctrl + Shift + I或fn + F12或F12
打开后,点击左上角的 “元素选择工具”(鼠标图标),再点击页面上的任意区域,即可查看该区域对应的 HTML 标签和类名。
你也可以使用搜索功能(Cmd/Ctrl + F)定位某个类名。
CleanShot 2025-07-09 at 17.55.28@2x.png

JavaScript#

自定义 JavaScript 适用于嵌入第三方服务的需求(如 AI 助手、客服面板等),请注意 Apifox 的自定义 JavaScript 区域不支持直接写 <script> 和 <style> 标签。你需要将这些内容改写为纯 JavaScript 实现,例如:
❌ 原始写法
✅ 适配后的纯 JS 写法
如果你想嵌入第三方脚本或样式,但不确定怎么改写为纯 JS 格式,可以复制下面的 Prompt 提示词粘贴到 AI 工具(如 DeepSeek)中,让 AI 帮你自动转换:
出于安全考虑,自定义 JavaScript 仅在使用 自定义域名 访问文档站时生效。
如果通过 Apifox 提供的默认文档地址访问(如 https://xxx.apifox.cn/ 开头),自定义 JS 将不会被加载执行。
请确保代码本身可靠,避免影响正常加载或破坏页面结构。
如果需要等待页面加载完成后再执行代码,请使用load而不是DOMContentLoaded,例如:

示例:点击按钮展开/收起 iframe 对话窗口#

“点击按钮展开/收起 iframe 对话窗口” 脚本
使用方法:
1
将代码粘贴到 Apifox 自定义 JS 区域
2
访问你的自定义域名文档站
3
右下角会出现一个按钮,点击后弹出对话窗口(iframe)
4
替换 iframe.src 为你自己的 AI 服务地址,如:
这里用 Apifox 官网地址来演示:
02-apifox-custom-js-css-html.gif

示例:嵌入 Dify 聊天应用#

“嵌入 Dify 聊天应用” 脚本
使用方法:
1
在 Dify 中创建一个应用,应用发布后选择“嵌入网站”,将代码复制下来,并用上文提到的 Prompt 提示词转换成纯 JavaScript 格式。
image.png
将转换后的代码粘贴到 Apifox 自定义 JS 区域。
2
访问你的自定义域名文档站
3
右下角会出现一个按钮,点击后弹出对话窗口。
01-apifox-custom-js-css-html.gif

HTML#

即将推出...

常见问题#

自定义 JS 没有生效?
请确认是否使用了 自定义域名 访问文档。只有在绑定并使用你自己的域名时,JavaScript 代码才会被加载执行。
为什么推荐使用 load 而不是 DOMContentLoaded
上一页
页面布局设置
下一页
自定义域名
Built with