YApi接口文档可完整迁移到Apifox,需全量导出JSON并确保含project和base_url字段,Apifox导入时选YApi格式且关闭自动创建环境,再校验分组、参数必填状态及Mock规则。

把YApi里维护好的接口文档完整迁移到Apifox,避免手动重建、字段丢失或目录结构错乱,是团队统一协作前最关键的一步。迁移过程本身不复杂,但YApi导出的JSON在字段定义、分组逻辑和Mock规则映射上与Apifox存在隐性差异,稍有疏忽就会导致接口路径错位、参数缺失或环境变量失效。
从YApi导出标准JSON文件
登录YApi平台,进入目标项目首页→点击左下角「数据管理」→选择「导出全部接口」→勾选「导出为JSON格式」→点击「导出」按钮。这一步必须使用「全部接口」导出,不能只导出某个分组——YApi的分组信息(如“用户服务”“订单中心”)只在全量导出时才写入JSON根节点的project字段中,否则Apifox无法还原原始目录树。
导出后检查JSON文件头部是否包含"name": "你的项目名"和"base_url"字段,若缺失,说明导出时未勾选「包含项目基础信息」,需重新导出。该字段是Apifox识别项目层级的关键依据。
在Apifox中选择YApi格式导入
打开Apifox → 进入目标团队 → 点击「+ 创建项目」→ 输入项目名称(建议与YApi原项目名一致)→ 项目类型选「RESTful API」→ 基础路径留空(由YApi JSON中的base_url自动填充)→ 点击「确认」创建项目。
项目创建完成后,点击左侧「接口管理」→ 在项目标题栏右侧点「更多」→ 选择「导入」→ 弹窗中「导入格式」下拉菜单选择「YApi」→ 将刚导出的JSON文件直接拖入虚线框内,或点击「选择文件」浏览上传。
【必须关闭「自动创建环境」开关】 否则Apifox会将YApi中已配置的测试/预发/生产环境重复生成三套,且默认值为空,后续调试时请求地址会拼接出错。
Apifox Linux 桌面版是一款专为 Linux 开发者打造的 API 一体化工具,集接口设计、调试、测试、Mock 和文档管理于一体。它在 Linux 环境下提供稳定、高效的本地运行体验,帮助开发者实现 API 全生命周期管理,是 Linux 开发者进行接口开发与联调的高效工具。
校验与修复关键项
导入完成后,系统自动展开左侧接口目录树。此时重点核对三项:
① 检查一级分组是否与YApi中「分组管理」完全对应,若出现“未分组接口”,说明YApi导出时部分接口未归属到任何分组;
② 随机点开3~5个典型接口,查看「请求参数」Tab页:YApi中设置为「非必填」的query参数,在Apifox中可能被误标为必填——这是因YApi JSON未显式标记required: false,需手动切换开关;
③ 进入「Mock」Tab页:YApi自定义的Mock规则(如返回固定手机号、随机金额)不会自动迁移,Apifox仅保留基础Mock响应体,需逐条重配规则表达式。
完成上述核对后,点击右上角「保存全部更改」,导入流程即告结束。

















