# FabricateData-local-api

**Repository Path**: dhuichi/FabricateDataApi

## Basic Information

- **Project Name**: FabricateData-local-api
- **Description**: 在node环境下，可在本地生成一个数据接口服务，该接口服务用于生产测试数据，供您其他本地程序调用。数据结构模型可在FabricateData（https://www.fabricatedata.com）官网中自定义，通过模型分享码导入本地接口服务。
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: https://www.fabricatedata.com
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-07-04
- **Last Updated**: 2025-09-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FabricateData-local-api

#### 介绍
在node环境下，可在本地生成一个数据接口服务，该接口服务用于生产测试数据，供您其他本地程序调用。数据结构模型可在FabricateData（https://www.fabricatedata.com）官网中自定义，通过模型分享码导入本地接口服务。



#### 安装教程

# 跨平台应用安装教程

## 一、环境准备

### 1. 检查Node.js版本
- **Windows/macOS 系统**：
  打开终端（Windows 可使用 PowerShell 或命令提示符，macOS 使用终端），输入以下命令：
  ```bash
  node -v
  ```
  若输出版本号低于 `v20.18.0`，需升级 Node.js。

- **Linux 系统**：
  打开终端，输入：
  ```bash
  node -v
  ```
  若版本不满足要求，可通过包管理器或 Node.js 官方安装脚本升级。

### 2. 安装/升级Node.js
- **Windows 系统**：
  1. 访问 [Node.js 官网](https://nodejs.org/) 下载最新 LTS 版本安装包（需 >=20.18.0）。
  2. 运行安装包，按提示完成安装，重启后重新检查版本。

- **macOS 系统**：
  - 使用 Homebrew 安装：
    ```bash
    brew install node
    ```
  - 若已安装旧版本，可通过 `brew upgrade node` 升级。

- **Linux 系统（以 Ubuntu 为例）**：
  ```bash
  curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
  sudo apt-get install -y nodejs
  ```

## 二、安装与运行应用

### 1. 解压应用压缩包
- 将下载的压缩包（如 `FabricateDataApi.zip` 或 `FabricateDataApi.tar.gz`）解压到任意目录，建议路径不含中文或特殊字符。

### 2. 打开终端并进入项目目录
- **Windows 系统**：
  1. 打开 PowerShell 或命令提示符。
  2. 使用 `cd` 命令进入项目目录，例如：
     ```bash
     cd D:\projects\FabricateDataApi
     ```

- **macOS/Linux 系统**：
  ```bash
  cd /path/to/FabricateDataApi
  ```

### 3. 初始化并安装依赖
在项目目录下执行：
```bash
npm install
```
等待依赖安装完成（首次安装可能需要几分钟）。

### 4. 运行应用
#### 方式一：使用 npm 脚本（推荐）
```bash
npm run start
```

#### 方式二：直接运行入口文件
```bash
node app.js
```

### 5. 验证应用运行
- 若控制台输出类似 
```bash
欢迎使用FabricateData接口服务！
请为你的接口设置一个端口(3000):
```
表示应用启动成功。
- 可以直接回车启动默认端口号，也可以自定义一个。

# 使用说明
简单两步，完成测试数据的准备，即可调用

### 1.  help
输入命令`help`,可查看命令帮助
```
输入命令：
- "help"：查看命令列表
- "import 分享码"：通过分享码导入数据模型
- "list"：查看所有的数据模型
- "model 分享码"：查看数据模型详情
- "del 分享码"：通过分享码删除数据模型
- "api"：查看如何调用接口服务
- "exit"：退出程序
```
### 2.  import 分享码
分享码为`https://www.fabricatedata.com`网站中模型的属性，生成后可导入本地，即可调用本地api生成测试数据。
```
(help)> import 7344058733360267269
正在导入数据模型，分享码：7344058733360267269
导入成功！模型为【测试数据源】
```

### 3.  api
输入命令`api`，查看api调用说明
```
(help)> api
API调用说明：
域名:端口: http://localhost:3000

1. GET|POST /api/generatedata - 生成数据（数组）
    参数：
        - shareCode : 数据模型的分享码
        - count : 生成数据的条数，最大10000条
        - execJS : 是否执行JavaScript脚本（true/false）
        - sleep : 延时执行时间，单位毫秒

    (GET)格式1: /:shareCode/:count/:execJS/:sleep
    (GET)示例1: http://localhost:3000/api/generatedata/yourShareCode/5/false/0

    (GET)格式2: ?shareCode=12321&count=5&execJS=false&sleep=0
    (GET)示例2: http://localhost:3000/api/generatedata?shareCode=12321&count=5&execJS=false&sleep=0

    (POST)格式3: Content-Type : application/json
    (POST)示例3: http://localhost:3000/api/generatedata
    (POST)参数3:
                {
                    "shareCode":"12321",
                    "count":5,
                    "execJS":false
                    "sleep":0
                }

    响应参数：
            {
                "success":true/false,
                "data":[]/null,
                "message":""
            }


2. GET|POST /api/generateobj - 生成数据（对象）
    参数：
        - shareCode : 数据模型的分享码
        - execJS : 是否执行JavaScript脚本（true/false）
        - sleep : 延时执行时间，单位毫秒

    (GET)格式1: /:shareCode/:execJS/:sleep
    (GET)示例1: http://localhost:3000/api/generateobj/yourShareCode/false/0

    (GET)格式2: ?shareCode=12321&execJS=false&sleep=0
    (GET)示例2: http://localhost:3000/api/generateobj?shareCode=12321&execJS=false&sleep=0

    (POST)格式3: Content-Type : application/json
    (POST)示例3: http://localhost:3000/api/generateobj
    (POST)参数3:
                {
                    "shareCode":"12321",
                    "execJS":false
                    "sleep":0
                }

    响应参数：
            {
                "success":true/false,
                "data":{}/null,
                "message":""
            }
```

# 进阶使用

### 1.  导入模型的批量操作
程序运行后，项目目录会自动生成`model-data`文件夹，这里面放着的就是所有模型，您可以全部删除，或者全部迁移至别的地方，如果您有多个电脑，可以直接迁移使用，不用在使用import导入。

### 2.  本地数据源管理
同样，项目目录里应该可以看到`source-data`文件夹，您的本地数据源必须存放在这里才能生效，且文件格式必须为txt，这需要模型搭配使用,详细使用请登录网站[FabricateData](https://www.fabricatedata.com)参考[本地数据源](https://www.fabricatedata.com/source)。

### 3.额外说明
本地数据源文件平台是准备支持`txt`和`json`两种类型的，其中`txt`为【数据源抽取】所用，`json`是未来支持联级数据抽取准备的特殊格式。