问题：Apifox如何配置读取本地文件作为接口数据源？

Question

**问题描述：** 在使用 Apifox 进行接口管理与调试时，部分开发者希望将本地文件（如 JSON、CSV 等）作为接口的数据源，以实现动态数据返回或模拟后端响应。然而，Apifox 本身并不直接支持读取本地文件作为接口数据源。那么，如何通过 Apifox 配合脚本或 Mock 服务实现读取本地文件数据，并将其作为接口响应内容返回？常见方法包括使用 Node.js 搭建本地 Mock 服务、利用 Apifox 的自定义脚本功能配合外部 API，或是通过自动化流程工具（如 Apifox 自动化测试）调用本地数据。请结合实际开发场景，说明实现该功能的具体配置步骤与技术要点。

Answer 1

一、问题背景与技术挑战

在现代 API 开发与测试流程中，Apifox 作为一款功能强大的接口管理与调试平台，广泛应用于前后端协作、接口文档维护以及自动化测试等场景。然而，在实际开发中，开发者常常面临一个需求：希望将本地文件（如 JSON、CSV 等）作为接口的数据源，以实现接口响应的动态模拟或数据驱动测试。

尽管 Apifox 提供了强大的 Mock 功能和脚本支持，但它本身并不支持直接读取本地文件系统中的数据文件。这就需要我们借助外部服务或脚本工具，构建一个桥梁，将本地文件内容注入到 Apifox 的接口响应中。

二、实现方式概述

根据不同的使用场景和开发习惯，我们可以采用以下三种常见方案来实现该功能：

1. 使用 Node.js 搭建本地 Mock 服务，读取本地文件并提供 HTTP 接口供 Apifox 调用。
2. 在 Apifox 的接口预执行脚本中调用外部 API，间接获取本地文件数据。
3. 通过 Apifox 自动化测试流程，结合脚本读取本地文件并模拟接口响应。

方案	优点	缺点
Node.js Mock 服务	灵活、可扩展性强、支持多种数据格式	需要额外搭建服务、部署成本略高
Apifox 自定义脚本 + 外部 API	集成简单、无需长期运行服务	依赖外部 API、数据更新需手动触发
自动化测试流程 + 脚本	适合批量测试、数据驱动测试	需编写测试脚本、灵活性较低

三、方案一：Node.js 搭建本地 Mock 服务

这是最常见也是最灵活的实现方式。通过搭建一个基于 Express 的 Node.js 服务，我们可以监听本地文件变化，并提供统一的 HTTP 接口供 Apifox 调用。

1. 创建项目结构

mock-server/
├── data/
│   └── sample.json
├── server.js
└── package.json

2. 安装依赖

npm init -y
npm install express fs path

3. 编写服务代码

const express = require('express');
const fs = require('fs');
const path = require('path');

const app = express();
const PORT = 3000;

app.get('/api/data', (req, res) => {
    const filePath = path.join(__dirname, 'data', 'sample.json');
    fs.readFile(filePath, 'utf8', (err, data) => {
        if (err) {
            return res.status(500).send('读取文件失败');
        }
        res.json(JSON.parse(data));
    });
});

app.listen(PORT, () => {
    console.log(`Mock 服务运行在 http://localhost:${PORT}`);
});

4. 启动服务

node server.js

5. Apifox 配置调用

在 Apifox 中新建接口，将接口地址设置为 http://localhost:3000/api/data，即可在接口响应中获取本地文件数据。

四、方案二：Apifox 自定义脚本调用外部 API

适用于不需要长期运行服务的场景，适合临时调试或演示。

1. 配置接口请求地址

在 Apifox 接口配置中，填写外部 Mock 服务地址，如 http://localhost:3000/api/data。

2. 编写前置脚本（可选）

// Apifox 前置脚本示例
console.log('开始请求外部 Mock 服务');

3. 设置响应 Mock 规则（可选）

// 示例：固定返回值
return {
    code: 200,
    data: JSON.parse(pm.environment.get('fileData'))
};

五、方案三：自动化测试流程调用本地文件

在 Apifox 自动化测试中，可以通过脚本读取本地文件并注入测试数据。

1. 准备测试脚本

const fs = require('fs');
const data = fs.readFileSync('test-data.json', 'utf8');
pm.environment.set('testData', data);

2. 在测试用例中使用数据

pm.test("测试响应数据", function () {
    pm.response.to.have.status(200);
    pm.expect(pm.response.json()).to.deep.equal(JSON.parse(pm.environment.get('testData')));
});

六、流程图示例

graph TD A[Apifox 接口请求] --> B{调用本地 Mock 服务?} B -->|是| C[Node.js 读取本地文件] B -->|否| D[调用外部 API 获取数据] C --> E[返回 JSON 数据] D --> E E --> F[Apifox 接口返回结果]