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
    • 概述
    • 新建 API 项目
    • 接口基础知识
    • 请求体多示例配置
    • 响应组件
    • 常用字段
    • 全局参数
    • 历史记录
    • 批量管理
    • 数据模型
      • 概述
      • 新建数据模型
      • 通过 JSON 等生成
      • 高级数据类型
      • 构建数据模型
    • 鉴权组件
      • 概述
      • 创建鉴权组件
      • 使用鉴权组件
      • 在线文档中的鉴权组件
    • 高级功能
      • 接口字段
      • 接口状态
      • 关联测试场景
      • 参数列表外观
      • 接口唯一标识
  • 开发和调试 API
    • 概述
    • 生成请求
    • 发送请求
    • 请求历史
    • 接口用例
    • 动态值
    • 校验响应
    • 文档模式/调试模式
    • 生成代码
    • 环境和变量
      • 概述
      • 全局/环境/临时变量
      • 环境与服务
      • Vault Secrets(密钥库)
        • 功能简介
    • 前后置操作&脚本
      • 概述
      • 断言
      • 提取变量
      • 等待时间
      • 数据库操作
        • 概述
        • 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 平台集成
  • 发布 API 文档
    • 概述
    • 快捷分享
    • 查看 API 文档
    • 发布文档站
    • 页面布局设置
    • 自定义域名
    • AI 相关特性
    • 高级设置
      • 文档站搜索设置
      • 跨域代理
      • 文档站接入 Google Analytics
      • SEO 设置
      • 文档左侧目录设置
      • 文档可见性设置
      • 在线 URL 链接规范
    • API 版本
      • 创建 API 版本
      • 发布 API 版本
      • 快捷分享 API 版本
      • 功能简介
  • 迭代分支
    • 功能简介
    • 新建迭代分支
    • 在迭代分支中改动 API
    • 在迭代分支中测试 API
    • 合并迭代分支
    • 管理迭代分支
  • 管理中心
    • 入驻清单
      • 了解基本概念
      • 团队入驻
    • 管理团队
      • 团队基本操作
      • 团队成员管理
      • 成员角色与权限设置
      • 团队资源
        • 通用 Runner
        • 请求代理 Agent
        • 团队变量
      • 实时协作
        • 团队协作
    • 管理项目
      • 项目基本操作
      • 项目成员管理
      • 通知设置
        • 功能简介
        • 通知对象
        • 通知事件
      • 项目资源
        • 数据库连接
    • 管理组织
      • 单点登录(SSO)
        • 功能简介
        • 为组织配置单点登录
        • 管理用户账号
        • 将组映射到团队
        • Microsoft Entra ID
      • SCIM 用户管理
        • 功能简介
        • Microsoft Entra ID
      • 组织资源
        • 自托管 Runner
  • IDEA 插件
    • 快速上手
    • 生成接口文档
    • 生成数据模型
    • 配置
      • 全局配置
      • 项目内配置
      • 可配置规则
      • 脚本工具
      • Groovy 本地扩展
    • 进阶配置
      • 注释规范说明
      • 框架支持
    • 常见问题
      • 常见问题
  • 浏览器扩展
    • Chrome
    • Microsoft Edge
  • Apifox MCP Server
    • 概述
    • 通过 MCP 使用 Apifox 项目内的 API 文档
    • 通过 MCP 使用公开发布的 API 文档
    • 通过 MCP 使用 OpenAPI/Swagger文档
  • 最佳实践
    • 概述
    • 接口之间如何传递数据
    • 登录态(Auth)如何处理
    • 接口签名如何处理
    • 如何加密/解密接口数据
    • Jenkins 定时触发任务
    • 如何计算 AI 问答成本
    • 与其他成员共用数据库连接配置
    • 通过 CLI 运行包含云端数据库连接配置的测试场景
    • 通过 Runner 运行包含云端数据库连接配置的测试场景
  • 账号&应用设置
    • 账号设置
    • 语言设置
    • 网络代理
    • 快捷键
    • 数据备份与恢复
    • 更新 Apifox
    • API 访问令牌
  • 身份验证 & 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 文档

快捷分享

在 API 设计、开发、沟通、协作中,逻辑上应该以团队内共同定义的 API 文档为标准。但实际操作中,团队成员习惯依靠 Word、PDF 格式文件进行 API 文档协作,造成大量信息未能及时同步,将接口以在线文档形式分享将有助于提高团队之间的沟通效率。

创建快捷分享#

在左侧切换到 “分享文档” 模块。
CleanShot 2024-12-10 at 18.09.52@2x.png
点击「+新建分享」按钮以创建快捷分享。一个项目可以创建多个不同的快捷分享,可以分发给不同的协作者。所有团队成员都能看到其他人创建的所有快捷分享。
在新建分享弹窗中,你可以自定义以下选项:
标题:此分享的名称,仅在 Apifox 团队内可见,用于内部识别,在分享的文档中不可见。
运行环境:选择在线文档中可用的环境。默认不选择任何环境,可以自由选择多个环境。读者可以在文档中看到已选择的环境,并在 “在线调试” 时使用这些环境。
创建文档时如果选择了云端 Mock 环境,相当于为文档读者开启了一个简单的沙箱环境。
展示内容:文档有两个可选组件:前置 URL 和示例代码。你可以选择是否在文档中显示它们。
前置 URL:这是在环境中设置的前置 URL。如果选中,文档中的每个接口都会显示完整 URL;如果不选中,文档中的 URL 将以"/"开头。
示例代码:是否显示调用请求的示例代码。。
允许导出数据:是否允许读者以 OAS/Markdown/HTML/Apifox 格式导出数据。
分享接口范围:选择要包含在此分享中的 API 和 Markdown。可以按目录选择或通过标签筛选和排除。
安全性:可以设置访问文档是否需要密码,以及文档的过期时间。如果不选择过期时间,则永不过期。
项目展示字段:接口字段中启用的自定义字段,可以设置这些字段是否在文档中显示。
文档语言:设置文档界面的显示语言,这会改变系统内置的一些文本显示,比如 “Query 参数”、“示例代码” 等固定用语,但不会影响你自己编写的 API 文档内容。
AI 相关特性:LLMs.txt 及 “复制页面” 功能默认开启,你无需额外设置即可使用,可在此管理启用状态。
高级设置:可以在这里设置隐藏 “在线调试” 按钮和隐藏 “Powered by Apifox”。

分享整个目录#

快捷分享支持 “分享整个目录” 功能。这适用于分享链接后,你可能在目录中增删了文档,希望协作者能同步看到这些变化的场景。
在 “分享接口范围” 中,选择 “手动圈选接口” 时,可以看到 “整目录分享” 选项。启用后,协作者将自动获得访问该目录下所有文档的权限,这样你就不需要在每次添加新文档时调整分享设置。

跨域代理#

在线分享给外部用户的文档,如果用户想要在文档页中调试接口,则很有可能碰到浏览器的跨域请求(CORS)问题。通过给该 “在线分享” 内容设置跨域代理即可帮助解决这个问题。用户从此分享页中发起的全部接口请求,都将会通过指定的请求代理 Agent,来代理发起请求。
在线分享的下方有跨域代理的设置入口,点击即可进行设置。所有在线分享默认会使用 Apifox 提供的 “云端 Agent” 来代理接口请求。
跨域代理
可以在跨域代理详情中,根据你的实际场景和使用需求,来设置使用具体某个跨域代理:
云端 Agent: 使用 Apifox 提供的云端请求代理 Agent 来代理从此分享页中发起的接口请求。需要注意这个 Agent 无法访问内网接口。
浏览器扩展: 使用用户在自己浏览器中安装的浏览器扩展作为 Agent 来发起请求。如果用户没有安装浏览器扩展则会在页面引导其安装扩展来发起请求。
不使用代理: 不使用跨域代理,请求将从用户浏览器直接发起到接口。需要注意接口服务端的配置以避免跨域问题。
自托管请求代理 Agent: 使用某个团队中部署的请求代理 Agent 来代理从此分享页中发起的接口请求。
跨域代理

示例代码#

创建分享时可以选择是否显示这个模块。
你可以自定义示例代码,具体步骤如下:
1.
在 “项目设置 - 功能设置 - 接口功能设置 - 接口字段” 中,开启示例代码字段。
2.
然后在 “接口 - 修改接口” 中,最后会出现示例代码模块。
3.
你可以在这里点击 添加示例代码,添加需要的语言示例。之后它会显示在文档中。
image.png

分享链接#

完成设置后,复制链接分享给团队成员。即可查看 API 文档。
image.png
修改于 2025-04-15 03:30:31
上一页
概述
下一页
查看 API 文档
Built with