基础

您应该定义一个 OpenAPI 规范（示例 petstore.yaml）。

然后在项目根目录创建一个 orval.config.js 文件：

orval.config.js 示例

1module.exports = {
2  'petstore-file-transfomer': {
3    output: {
4      mode: 'single',
5      target: './src/petstore.ts',
6      schemas: './src/model',
7      mock: true,
8    },
9    input: {
10      target: './petstore.yaml',
11    },
12  },
13};

输出选项配置您想要写入生成代码的内容和位置。

• mode 是您定义生成文件方式的地方（默认：single - 只有一个包含所有内容的文件）
• target 是默认写入生成代码的位置
• schemas 是写入模型的位置
• mock 是当您想要使用模拟生成器生成模拟时（默认是 MSW）。它将在目标文件中生成。您可以查看 MSW 以在项目中正确设置它们。

输入选项配置导入的规范以及您想要覆盖的内容。

• target 是规范文件
• override 是快速覆盖输入
  • transformer 转换规范，比如为每个调用添加参数。

查看 orval 配置 以了解所有可用选项。