Skip to content

Commit

Permalink
docs(mock): update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@liangskyli
liangskyli committed Jul 2, 2022
1 parent 79a72cb commit 15a025b
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions packages/http-mock-gen/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,17 +40,17 @@ yarn http-mock-gen -c ./mock.config.cli.ts

## 命令参数 configFile mock数据生成配置文件参数属性

| 属性 | 说明 | 类型 | 默认值 |
|------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| mockDir | mock文件夹所在目录 | `string` | `./` |
| jsonSchemaFakerOptions | 生成mock 数据 faker配置参数 | 详情配置见 [json-schema-faker options文档](https://github.com/json-schema-faker/json-schema-faker/blob/HEAD/docs/README.md#available-options) | `{ alwaysFakeOptionals: true, fillProperties: false }` |
| mockDataReplace | 生成mock 数据处理函数，可以覆盖faker数据 | `(this: any, key: string, value: any) => any` | `undefined` |
| openapiPath | openapi v3 YAML or JSON 格式的文件路径,需要自己根据业务逻辑生成 | `string` | |
| genTsDir | 生成ts文件夹所在目录 | `string` | `未设置时，默认mockDir配置目录下mock文件夹` |
| prettierOptions | 生成文件格式化，默认取项目配置，该配置优先级更高，会合并覆盖项目prettier配置文件，如项目有prettier配置文件，这里无需配置 | 详情配置见 [prettier文档](https://github.com/prettier/prettier/blob/main/docs/options.md) | |
| requestFilePath | ajax请求库路径，默认使用axios,文件默认导出函数 | `string` | `undefined` |
| requestQueryOmit | ajax请求库里对公共get参数做了传入处理时，请求接口忽略get参数ts类型声明 | `string[]` | `undefined` |
| requestBodyOmit | ajax请求库里对公共post参数做了传入处理时，请求接口忽略post参数ts类型声明 | `string[]` | `undefined` |
| 属性 | 说明 | 类型 | 默认值 |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|
| mockDir | mock文件夹所在目录 | `string` | `./` |
| jsonSchemaFakerOptions | 生成mock 数据 faker配置参数 | 详情配置见 [json-schema-faker options文档](https://github.com/json-schema-faker/json-schema-faker/blob/HEAD/docs/README.md#available-options) | `{ alwaysFakeOptionals: true, fillProperties: false }` |
| mockDataReplace | 生成mock 数据处理函数，可以覆盖faker数据 | `(this: any, key: string, value: any) => any` | `undefined` |
| openapiPath | openapi v3 YAML or JSON 格式的文件路径,需要自己根据业务逻辑生成。如果使用routing-controllers，可以使用[@liangskyli/routing-controllers-openapi 工具生成openapi文件](https://github.com/liangskyli/routing-controllers-openapi) | `string` | |
| genTsDir | 生成ts文件夹所在目录 | `string` | `未设置时，默认mockDir配置目录下mock文件夹` |
| prettierOptions | 生成文件格式化，默认取项目配置，该配置优先级更高，会合并覆盖项目prettier配置文件，如项目有prettier配置文件，这里无需配置 | 详情配置见 [prettier文档](https://github.com/prettier/prettier/blob/main/docs/options.md) | |
| requestFilePath | ajax请求库路径，默认使用axios,文件默认导出函数 | `string` | `undefined` |
| requestQueryOmit | ajax请求库里对公共get参数做了传入处理时，请求接口忽略get参数ts类型声明 | `string[]` | `undefined` |
| requestBodyOmit | ajax请求库里对公共post参数做了传入处理时，请求接口忽略post参数ts类型声明 | `string[]` | `undefined` |

- configFile mock数据生成配置文件示例

Expand Down Expand Up @@ -83,6 +83,7 @@ export default config;

- openapi v3 YAML or JSON 格式的文件[示例](https://github.com/liangskyli/openapi-ts/blob/master/packages/openapi-gen-ts/docs/openapiv3-example.json) ，[openapi](https://www.openapis.org/) 需要自己根据业务逻辑生成。
- openapi v3 method 只支持 get post接口，只生成application/json响应数据
- 如果你的http接口使用routing-controllers,可以使用[@liangskyli/routing-controllers-openapi 工具生成openapi文件](https://github.com/liangskyli/routing-controllers-openapi)
- openpai 生成数据类型和接口使用说明，详见[使用说明](https://github.com/liangskyli/openapi-ts)
- 生成mock 数据结构，最终使用interface-mock-data.ts文件
- Mock 数据修改指引 [文档](docs/http-mock-modify-guide.md)
Expand Down

0 comments on commit 15a025b

Please sign in to comment.