Apifox 帮助文档
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
帮助文档
常见问题
Apifox 官网
私有化部署
开发者中心
开放 API
更新日志
Road Map
Apifox Markdown
下载
下载 Apifox
下载 IDEA 插件
下载浏览器扩展
Apifox Web 版
导入导出数据
复制页面
帮助中心
更新日志
入门
产品介绍
联系我们
私有化部署
开始使用
下载 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
动态值表达式
常见问题
导入导出数据
复制页面
定时导入
如果你在 Apifox 之外维护 API 定义
(
API specification
)
,但希望使用 Apifox 进行 API 调试、测试和文档管理,你可以使用定时导入功能。
创建定时导入
#
1
前往
设置
-
导入 数据
-
定时导入
2
点击 “
新建
” 来创建一个数据源。
3
填写必要信息,例如导入频率、数据源的 URL 等。
4
点击
保存
。定时导入会根据你设置的导入频率自动执行。
工作原理
#
定时导入的工作方式如下:默认情况下,定时导入是从你的
本地客户端
启动的。首先,你的 Apifox 客户端会访问数据源,获取数据后再更新到 Apifox 项目中。
这意味着:
1.
定时导入仅在客户端打开时执行。具体来说,只有当你对项目有写入权限、项目已经在客户端打开,并且距离上一次定时导入的时间超过了你设置的导入频率间隔时,定时导入才会执行。
2.
定时导入可以将内网数据导入到 Apifox,只要你的客户端可以正常访问数据源地址。
因此,如果项目长时间未打开,定时导入将不会生效。下次打开时才会进行更新。
如果你在
Apifox Web
版中打开项目,也会触发定时导入。但在这种情况下可能会有些不同:由于浏览器网络环境的限制,Web 版可能无法访问内网数据。
为了解决上述问题,Apifox 提供了第二种定时导入机制:你可以通 过自托管的 Runner 来启动导入,而不是依赖本地客户端。
如果你已经在服务器上部署了 Runner,Runner 将会按照固定的时间间隔自动从数据源导入数据,而不需要考虑客户端是否打开。
了解更多关于
自托管 Runner
的信息。
导入迭代分支
#
可以选择一个迭代分支定时导入数据,默认选中主分支。如果切换了其他迭代分支,会按照设置规则定时向这个迭代分支中导入数据。导入迭代分支的详情可以参考
将 OAS 导入迭代分支
模块。
定时导入选项
#
导入频率
:设置多久触发一次导入。如果上次导入后的时间超过了该时间段,导入将会被触发。
数据源格式
:支持 OpenAPI、ApiDoc 或 Apifox 等格式。
数据源名称
:自定义名称,用于区分不同的数据源。
数据源 URL
:数据源的 JSON/Yaml 文件 URL,例如:
https://petstore.swagger.io/v2/swagger.json
运行位置
:选择定时导入的启动位置。默认是本地客户端,你也可以选择已部署的 Runner。
Basic Auth
:用于访问加密的 URL。
高级设置
:请查看
导入设置
。
Apifox 支持在单个项目中创建多个数据源,并将数据同步到不同的文件夹中。
修改于
2025-01-08 11:01:25
上一页
手动导入
下一页
导入设置