yx_generate_api_js/templates/yx-generate-api.config.mjs

43 lines
1.4 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

export default {
// Swagger/OpenAPI 来源。
// 支持 http(s)、file://,也支持本地 JSON 文件路径。
swaggerUrl: 'http://127.0.0.1:8080/swagger/v1/swagger.json',
// 远程 Swagger 加载超时时间,单位毫秒。
swaggerTimeoutMs: 20000,
// 生成文件输出目录。
// 相对路径会基于当前配置文件所在目录解析。
outputDir: 'src/api/generated',
// 由 `sync` / `gen` 维护的外部 API 入口文件。
externalIndexFile: 'src/api/index.js',
// 写入到生成模块中的 request 导入路径。
// 这个路径必须相对于每个生成后的模块文件来写。
requestImport: '../request',
// 生成函数的参数风格,可选 'object' 或 'positional'。
paramStyle: 'object',
// 全量生成时,是否清理已经过期的自动生成模块文件。
// 如果是部分模块生成,会自动跳过清理,避免误删其他模块。
cleanOutput: true,
sync: {
// 如果你只想生成文件、不想改 externalIndexFile可以设为 false。
enabled: true,
// 是否在受管区块中附带 generated/index.js 的注释快照。
includeGeneratedIndexSnapshot: true,
// externalIndexFile 里受管区块的开始和结束标记。
blockStart: '// AUTO-GENERATED API EXPORTS START',
blockEnd: '// AUTO-GENERATED API EXPORTS END',
// 可选:
// snapshotTitle: '// generated/index.js content:',
// exportFrom: './generated',
},
}