Skip to main content

输入配置

target

类型:String

有效值:规范文件的路径或链接。

module.exports = {
petstore: {
input: {
target: './petstore.yaml',
},
},
};

validation

类型:BooleanObject

默认值:false

为了尽可能确保规范的最佳质量,我们集成了出色的 IBM OpenAPI 检查器

指定 true 将默认使用 IBM Cloud 验证规则集。 指定 Object 将使用提供的规则集。您可以在这里了解更多关于创建规则集的信息。

module.exports = {
petstore: {
input: {
validation: true,
},
},
};

override

类型:Object

为您提供覆盖规范的可能性

transformer

类型:StringFunction

有效值:转换器函数的路径或实现。

此函数在生成时执行,接受一个 OpenAPIObject 作为参数,并应返回一个 OpenAPIObject

module.exports = {
input: {
override: {
transformer: 'src/api/transformer/add-version.js',
},
},
};

转换器示例请参见这里

filters

类型:Object

默认值:{}

如果指定,Orval 只会在应用过滤器后生成端点。

mode

类型:String

有效值:includeexclude

默认值:include

tagsschemas 结合使用,此设置决定是包含还是排除指定的项目。 例如,下面的示例生成不包含标签 pets 的端点。

module.exports = {
petstore: {
input: {
filters: {
mode: 'exclude',
tags: ['pets'],
},
},
},
};

tags

类型:stringRegExp 数组。

默认值:[]

可以根据 tags 进行过滤。 例如,下面的示例只生成包含标签 pets 或匹配正则表达式 /health/ 的端点。

module.exports = {
petstore: {
input: {
filters: {
tags: ['pets', /health/],
},
},
},
};

schemas

类型:stringRegExp 数组。

只有模式名称匹配指定的 stringRegExp 才会自动生成。 例如,下面的示例只生成匹配字符串 Error 或正则表达式 /Cat/schema 对象。

module.exports = {
petstore: {
input: {
filters: {
schemas: ['Error', /Cat/],
},
},
},
};

converterOptions

类型:Object

默认值:{}

Orval 将 Swagger 2.0 定义转换为 OpenAPI 3.0.x。您可以使用 converterOptions 属性为此提供自定义配置。可用选项请查看这里

module.exports = {
petstore: {
input: {
converterOptions: true,
},
},
};

parserOptions

类型:Object

默认值:{ resolve: { github: githubResolver }, validate: true }

Orval 使用解析器来处理多个文件规范。您可以使用 parserOptions 属性自定义其行为。配置的可用选项请参见链接。默认情况下,Orval 包含一个 GitHub 解析器,但您可以为私有规范或其他特定需求添加自己的解析器。

您的规范默认会自动验证。

module.exports = {
petstore: {
input: {
parserOptions: {
resolve: { gitlab: gitlabResolver },
},
},
},
};
Was this page helpful?