OpenAPI Generator 如何用 global-property 只生成指定的 models、apis 或 supportingFiles【免费下载链接】openapi-generatorOpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)项目地址: https://gitcode.com/GitHub_Trending/op/openapi-generator用 OpenAPI Generator 从一份 OpenAPI 规范生成代码时默认会把该生成器支持的全部内容都写出来。如果你的目标只是其中一部分——比如只要User和Pet两个模型或只要某一个 supporting file——可以在generate命令里通过--global-propertyMaven/Gradle 中对应globalProperty做选择性生成。本文基于项目文档 docs/customization.md、docs/global-properties.md 与 docs/configuration.md 给出 CLI、Maven、Gradle 三种写法以及如何验证只写出了你要的文件。可选哪些生成类别docs/global-properties.md 列出了与选择性生成直接相关的 global properties属性作用可接受的值models限定生成哪些模型不传值整类或冒号分隔的模型名列表apis限定生成哪些 API不传值整类或冒号分隔的 API 名列表supportingFiles限定生成哪些 supporting files不传值整类或冒号分隔的文件名列表apiDocs/modelDocs是否生成 API/模型文档true或falseapiTests/modelTests是否生成 API/模型测试true或false默认行为是生成该库支持的所有内容一旦启用上面的任一选项生成范围就会被限制。文档同时提醒models、apis、supportingFiles等属性更推荐搭配功能更完善的.openapi-generator-ignore使用见 docs/customization.md 的 Ignore file format 一节该文件必须位于输出目录根部。CLI 写法先整类再具体到名字docs/usage.md 中generate命令的参数说明--global-property global properties的格式是namevalue,namevalue也可以多次传该选项每次一个namevalue。最小可用命令需要-g生成器、-ispec 文件、-o输出目录选择性生成选项叠加在--global-property上。只生成某一整类不传值后留空或不写# generate only models --global-property models # generate only apis --global-property apis # generate only supporting files --global-property supportingFiles # generate models and supporting files --global-property models,supportingFiles具体到指定的模型、API 或 supporting file用冒号分隔的名字列表。以 Java 生成器为例完整命令# 只生成 User 和 Pet 两个模型 openapi-generator generate -g java -i spec.yaml -o out \ --global-property modelsUser:Pet # 只生成 User 模型和 supportingFile StringUtil.java openapi-generator generate -g java -i spec.yaml -o out \ --global-property modelsUser,supportingFilesStringUtil.java其中spec.yaml换成你的 OpenAPI 规范文件out是输出目录对应 docs/usage.md 中-i、-o的含义。模型/API 名和文件名要与 spec 中的实际定义一致否则匹配不上。还可以叠加apiDocs、modelDocs、apiTests、modelTests控制文档和测试是否生成。这些选项默认为true并且不影响上面models、apis等类别限制本身docs/customization.md 原话示例# generate only models (with tests and documentation) --global-property models # generate only models (with tests but no documentation) --global-property models,modelDocsfalse # generate only User and Pet models (no tests and no documentation) --global-property modelsUser:Pet,modelTestsfalse # generate only apis (without tests) --global-property apis,apiTestsfalse # generate only apis (modelTests option is ignored) --global-property apis,modelTestsfalse注意最后一行的说明只生成 apis 时modelTests选项会被忽略。一个行为细节使用选择性生成时只有当前这次生成所需模板会被使用docs/customization.mdWhen using selective generation,onlythe templates needed for the specific generation will be used.。Maven 与 Gradle 插件中的等价写法同一个选择性生成属性在不同工具里的声明方式不同docs/configuration.md 专门对比了这一点。Gradle 插件globalProperties直接写成字符串空字符串表示整类如生成所有 apisopenApiGenerate { globalProperties.set([ apis: , models: User:Pet ]) }Maven 插件受 XML 语法限制apis/与apis/apis会被当作未定义无法表达空字符串 整类因此插件提供了一组独立开关modules/openapi-generator-maven-plugin/README.md选项默认说明generateApis/apisToGeneratetrue/ 全部生成 APIapisToGenerate为逗号分隔的 API 名列表generateModels/modelsToGeneratetrue/ 全部生成模型modelsToGenerate为逗号分隔的模型名列表generateSupportingFiles/supportingFilesToGeneratetrue/ 全部生成 supporting filessupportingFilesToGenerate为逗号分隔的文件名列表generateApiTests/generateApiDocumentationtrue仅在generateApis为true时有效generateModelTests/generateModelDocumentationtrue仅在generateModels为true时有效Maven 中也可以用与 CLI 等价的globalProperties配置节点modules/openapi-generator-maven-plugin/README.md 示例对应 CLI 的--global-property modelsUser:Petconfiguration globalProperties modelsUser:Pet/models /globalProperties /configuration该示例与下面的写法等价区别在于generateModels、modelsToGenerate也可以定义为 Maven property而globalProperties只能写成 configuration 节点configuration generateModelstrue/generateModels modelsToGenerateUser:Pet/modelsToGenerate /configuration两种传值方式Java System Property 与 --global-propertydocs/global-properties.md 说明选择性生成的 global properties 有两种传入方式Java System Properties或工具选项CLI 的--global-property、Maven/Gradle 的globalProperty。这个区分从 5.0 版本开始才成立——5.0 移除了旧的-DCLI 选项并将systemProperties重命名。两者等价例如java -Dmodels {jar} generate {opts}与java {jar} generate {opts} --global-propertymodels文档提醒docs/customization.md 中的示例用的是 Java System Property 语法但两种写法效果相同。如果你的版本在 5.0 以下升级上来不要继续依赖-D工具选项。如何确认只生成了指定内容生成后检查输出目录是最直接的验证-o out下应该只有你指定的模型/API/supported file 相关文件。例如--global-property modelsUser:Pet之后模型包里应只有User与Pet对应的文件而不是 spec 中全部 schemas。生成前可以用--dry-run预演。docs/usage.md 对它的描述是Try things out and report on potential changes (without actually making changes)docs/debugging.md 进一步说明dry-run 输出会列出正常运行时会写入的文件文件名前有n表示内容不同才会覆盖写入以w开头的行表示一定会产生写操作openapi-generator generate -g java -i spec.yaml -o out \ --global-property modelsUser:Pet --dry-run对照列出清单是否只包含User、Pet相关条目即可确认选择性生成生效再正式执行不带--dry-run的命令。限制与边界models、apis、supportingFiles在 docs/global-properties.md 中被明确标注Prefer using the more robust.openapi-generator-ignore。如果控制的是输出目录中具体文件而不是模板类别ignore 文件是文档推荐的路径它必须放在输出目录根部首次生成时可用--ignore-file-override/path/to/ignore_file指定该选项是完整覆盖。apiDocs、modelDocs、apiTests、modelTests默认为true且它们不改变models/apis等类别限制的范围只生成 apis 时modelTests会被忽略。选择性生成只影响用哪些模板不改变模板内容本身模板变量的排查可用--global-property debugModels、debugOperations、debugSupportingFilesdocs/debugging.md需要时再查该文档。【免费下载链接】openapi-generatorOpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)项目地址: https://gitcode.com/GitHub_Trending/op/openapi-generator创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
OpenAPI Generator 如何用 global-property 只生成指定的 models、apis 或 supportingFiles【免费下载链接】openapi-generatorOpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)项目地址: https://gitcode.com/GitHub_Trending/op/openapi-generator用 OpenAPI Generator 从一份 OpenAPI 规范生成代码时默认会把该生成器支持的全部内容都写出来。如果你的目标只是其中一部分——比如只要User和Pet两个模型或只要某一个 supporting file——可以在generate命令里通过--global-propertyMaven/Gradle 中对应globalProperty做选择性生成。本文基于项目文档 docs/customization.md、docs/global-properties.md 与 docs/configuration.md 给出 CLI、Maven、Gradle 三种写法以及如何验证只写出了你要的文件。可选哪些生成类别docs/global-properties.md 列出了与选择性生成直接相关的 global properties属性作用可接受的值models限定生成哪些模型不传值整类或冒号分隔的模型名列表apis限定生成哪些 API不传值整类或冒号分隔的 API 名列表supportingFiles限定生成哪些 supporting files不传值整类或冒号分隔的文件名列表apiDocs/modelDocs是否生成 API/模型文档true或falseapiTests/modelTests是否生成 API/模型测试true或false默认行为是生成该库支持的所有内容一旦启用上面的任一选项生成范围就会被限制。文档同时提醒models、apis、supportingFiles等属性更推荐搭配功能更完善的.openapi-generator-ignore使用见 docs/customization.md 的 Ignore file format 一节该文件必须位于输出目录根部。CLI 写法先整类再具体到名字docs/usage.md 中generate命令的参数说明--global-property global properties的格式是namevalue,namevalue也可以多次传该选项每次一个namevalue。最小可用命令需要-g生成器、-ispec 文件、-o输出目录选择性生成选项叠加在--global-property上。只生成某一整类不传值后留空或不写# generate only models --global-property models # generate only apis --global-property apis # generate only supporting files --global-property supportingFiles # generate models and supporting files --global-property models,supportingFiles具体到指定的模型、API 或 supporting file用冒号分隔的名字列表。以 Java 生成器为例完整命令# 只生成 User 和 Pet 两个模型 openapi-generator generate -g java -i spec.yaml -o out \ --global-property modelsUser:Pet # 只生成 User 模型和 supportingFile StringUtil.java openapi-generator generate -g java -i spec.yaml -o out \ --global-property modelsUser,supportingFilesStringUtil.java其中spec.yaml换成你的 OpenAPI 规范文件out是输出目录对应 docs/usage.md 中-i、-o的含义。模型/API 名和文件名要与 spec 中的实际定义一致否则匹配不上。还可以叠加apiDocs、modelDocs、apiTests、modelTests控制文档和测试是否生成。这些选项默认为true并且不影响上面models、apis等类别限制本身docs/customization.md 原话示例# generate only models (with tests and documentation) --global-property models # generate only models (with tests but no documentation) --global-property models,modelDocsfalse # generate only User and Pet models (no tests and no documentation) --global-property modelsUser:Pet,modelTestsfalse # generate only apis (without tests) --global-property apis,apiTestsfalse # generate only apis (modelTests option is ignored) --global-property apis,modelTestsfalse注意最后一行的说明只生成 apis 时modelTests选项会被忽略。一个行为细节使用选择性生成时只有当前这次生成所需模板会被使用docs/customization.mdWhen using selective generation,onlythe templates needed for the specific generation will be used.。Maven 与 Gradle 插件中的等价写法同一个选择性生成属性在不同工具里的声明方式不同docs/configuration.md 专门对比了这一点。Gradle 插件globalProperties直接写成字符串空字符串表示整类如生成所有 apisopenApiGenerate { globalProperties.set([ apis: , models: User:Pet ]) }Maven 插件受 XML 语法限制apis/与apis/apis会被当作未定义无法表达空字符串 整类因此插件提供了一组独立开关modules/openapi-generator-maven-plugin/README.md选项默认说明generateApis/apisToGeneratetrue/ 全部生成 APIapisToGenerate为逗号分隔的 API 名列表generateModels/modelsToGeneratetrue/ 全部生成模型modelsToGenerate为逗号分隔的模型名列表generateSupportingFiles/supportingFilesToGeneratetrue/ 全部生成 supporting filessupportingFilesToGenerate为逗号分隔的文件名列表generateApiTests/generateApiDocumentationtrue仅在generateApis为true时有效generateModelTests/generateModelDocumentationtrue仅在generateModels为true时有效Maven 中也可以用与 CLI 等价的globalProperties配置节点modules/openapi-generator-maven-plugin/README.md 示例对应 CLI 的--global-property modelsUser:Petconfiguration globalProperties modelsUser:Pet/models /globalProperties /configuration该示例与下面的写法等价区别在于generateModels、modelsToGenerate也可以定义为 Maven property而globalProperties只能写成 configuration 节点configuration generateModelstrue/generateModels modelsToGenerateUser:Pet/modelsToGenerate /configuration两种传值方式Java System Property 与 --global-propertydocs/global-properties.md 说明选择性生成的 global properties 有两种传入方式Java System Properties或工具选项CLI 的--global-property、Maven/Gradle 的globalProperty。这个区分从 5.0 版本开始才成立——5.0 移除了旧的-DCLI 选项并将systemProperties重命名。两者等价例如java -Dmodels {jar} generate {opts}与java {jar} generate {opts} --global-propertymodels文档提醒docs/customization.md 中的示例用的是 Java System Property 语法但两种写法效果相同。如果你的版本在 5.0 以下升级上来不要继续依赖-D工具选项。如何确认只生成了指定内容生成后检查输出目录是最直接的验证-o out下应该只有你指定的模型/API/supported file 相关文件。例如--global-property modelsUser:Pet之后模型包里应只有User与Pet对应的文件而不是 spec 中全部 schemas。生成前可以用--dry-run预演。docs/usage.md 对它的描述是Try things out and report on potential changes (without actually making changes)docs/debugging.md 进一步说明dry-run 输出会列出正常运行时会写入的文件文件名前有n表示内容不同才会覆盖写入以w开头的行表示一定会产生写操作openapi-generator generate -g java -i spec.yaml -o out \ --global-property modelsUser:Pet --dry-run对照列出清单是否只包含User、Pet相关条目即可确认选择性生成生效再正式执行不带--dry-run的命令。限制与边界models、apis、supportingFiles在 docs/global-properties.md 中被明确标注Prefer using the more robust.openapi-generator-ignore。如果控制的是输出目录中具体文件而不是模板类别ignore 文件是文档推荐的路径它必须放在输出目录根部首次生成时可用--ignore-file-override/path/to/ignore_file指定该选项是完整覆盖。apiDocs、modelDocs、apiTests、modelTests默认为true且它们不改变models/apis等类别限制的范围只生成 apis 时modelTests会被忽略。选择性生成只影响用哪些模板不改变模板内容本身模板变量的排查可用--global-property debugModels、debugOperations、debugSupportingFilesdocs/debugging.md需要时再查该文档。【免费下载链接】openapi-generatorOpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)项目地址: https://gitcode.com/GitHub_Trending/op/openapi-generator创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
![Sprint [] Planning - [Date]](http://pic.xiahunao.cn/yaotu/Sprint [] Planning - [Date])
