<commit_before># matman
Mock service and Tester assistant

## application

```
# 启动服务器
npm run server-babel;

# 前端页面编译
npm run webpack;
```

## 系统 CGI

`/sys-cgi/mocker`: 获得 mocker 的列表

## 字段定义

mocker 的 `config.json` 文件中字段的定义

| 字段名 | 是否必须 | 含义描述 |
| --- | --- | --- |
| `route` | 是 | 路由 |
| `params` | 否 | 数组，如果路由中包含了参数，则必须定义它。例如 `/a/b/id/:id`，则需要定义 `[{"name": "id","type": "number"}]` |
| `method` | 否 | 请求类型：`get`、`post` 等， 默认为 `get` |
| `version` | 否 | 版本号 |
| `description` | 否 | 描述，默认值为name字段的值 |
| `author` | 否 | 作者 |
| `name` | 否 | 名字，默认为文件名 |
| `defaultModule` | 否 | 默认的 mock module 模块，如果不填，则会按文件名取第一个 mock module |

mock module 的 `config.json` 文件中字段的定义

| 字段名 | 是否必须 | 含义描述 |
| --- | --- | --- |
| `version` | 否 | 版本号 |
| `description` | 否 | 描述，默认值为name字段的值 |
| `author` | 否 | 作者 |
| `name` | 否 | 名字，默认为文件名 |
| `query` | 否 | 对象，额外的请求参数和值 |<commit_msg>docs: 文档<commit_after># matman
Mock service and Tester assistant

## application

```
# 启动服务器
npm run server-babel;

# 前端页面编译
npm run webpack;
```

## 系统 CGI

`/sys-cgi/mocker`: 获得 mocker 的列表

## 字段定义

mocker 的 `config.json` 文件中字段的定义

| 字段名 | 是否必须 | 含义描述 |
| --- | --- | --- |
| `route` | 是 | 路由 |
| `params` | 否 | 数组，如果路由中包含了参数，则必须定义它。例如 `/a/b/id/:id`，则需要定义 `[{"name": "id","type": "number"}]` |
| `method` | 否 | 请求类型：`get`、`post` 等， 默认为 `get` |
| `version` | 否 | 版本号 |
| `description` | 否 | 描述，默认值为name字段的值 |
| `author` | 否 | 作者 |
| `name` | 否 | 名字，默认为文件名 |
| `defaultModule` | 否 | 默认的 mock module 模块，如果不填，则会按文件名取第一个 mock module |

mock module 的 `config.json` 文件中字段的定义

| 字段名 | 是否必须 | 含义描述 |
| --- | --- | --- |
| `version` | 否 | 版本号 |
| `description` | 否 | 描述，默认值为name字段的值 |
| `author` | 否 | 作者 |
| `name` | 否 | 名字，默认为文件名 |
| `query` | 否 | 对象，额外的请求参数和值 |

如果是 mock 数据，则在 response header 中会有 `matman-mocker` 和 `matman-mock-module` 字段。
{'fraction_non_alphanumeric': 0.21579532814238042, 'fraction_numerical': 0.0, 'mean_word_length': 3.183720930232558, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '390513', 'n_tokens_mistral': 1059, 'n_tokens_neox': 1176, 'n_words': 189}