如何通过OpenAPI Generator CLI将API服务地址设为变量适配多环境？

问题描述 #

我正在使用OpenAPI Generator CLI从template.yml文件生成端点API服务。目前模板中server的URL是固定字符串，由于需要区分开发环境（dev）与生产环境（prod）的服务地址，希望将该URL设为变量。当前模板配置如下：

openapi: 3.0.0
servers:
  - url: 'http://localhost:8080/MyApiCustom'

请问是否可以在openapi generate命令中传入参数供模板使用，或者在模板中直接使用环境变量？

解决方案 #

方法1：通过CLI参数动态替换 #

OpenAPI Generator支持通过--global-property（简写-g）参数传入全局变量，配合模板占位符实现动态替换。

1. 修改模板文件：将固定URL替换为占位符（比如{{serverUrl}}）

openapi: 3.0.0
servers:
  - url: '{{serverUrl}}'

2. 执行生成命令时传入环境参数：

• 开发环境：

openapi generate -i template.yml -g [你的生成器类型，例如spring/python-flask] -o ./output -g serverUrl=http://dev.example.com/MyApiCustom

• 生产环境：

openapi generate -i template.yml -g [你的生成器类型] -o ./output -g serverUrl=http://prod.example.com/MyApiCustom

方法2：直接在模板中使用环境变量 #

可以直接在OpenAPI模板中引用系统环境变量，Generator会自动读取并替换。

1. 修改模板文件：用环境变量占位符替换固定URL（通用语法为${ENV_VAR_NAME}）

openapi: 3.0.0
servers:
  - url: '${API_SERVER_URL}'

2. 设置环境变量后执行生成命令：

• Linux/macOS：

export API_SERVER_URL=http://dev.example.com/MyApiCustom
openapi generate -i template.yml -g [你的生成器类型] -o ./output

• Windows（PowerShell）：

$env:API_SERVER_URL = "http://dev.example.com/MyApiCustom"
openapi generate -i template.yml -g [你的生成器类型] -o ./output

注意：部分特定语言的生成器可能对环境变量语法有细微调整（比如部分用{{env.API_SERVER_URL}}），可根据使用的生成器调整占位符格式。

内容的提问来源于stack exchange，提问作者Vincent Laval