You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何配置OpenAPI Generator为接口生成URL字符串常量?

如何让OpenAPI Generator生成Endpoint对应的URL常量

方法1:用SpringCodegen内置配置(推荐)

针对Spring代码生成器,你可以通过配置参数开启URL常量生成:

  • 命令行添加参数:--additional-properties generateOperationUrlConsts=true
  • 或在config.json配置文件中加入:
{
  "generateOperationUrlConsts": true
}

开启后,生成的API接口类会自动为每个endpoint生成对应静态String常量,格式和你示例一致,比如String COUNTRY = "/country"。

方法2:自定义模板

如果内置配置达不到需求,可修改OpenAPI Generator的模板文件:

  1. 找到SpringCodegen对应的接口模板(一般是api.mustache)
  2. 在模板中加入遍历paths节点生成常量的逻辑:
{{#operations}}
{{#isFirst}}
public interface {{classname}} {

{{/isFirst}}
    static final String {{pathName}} = "{{path}}";
{{/operations}}

其中pathName需要通过模板变量处理成大写常量名(比如把/country转为COUNTRY),可借助模板引擎的字符串处理函数实现。

注意事项

  • 该功能在OpenAPI Generator v5.x及以上版本支持,旧版本建议先升级。
  • 带路径参数的endpoint(比如/country/{id}),生成的常量会保留占位符格式,例如String COUNTRY_ID = "/country/{id}"。

内容的提问来源于stack exchange,提问作者ka3ak

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.07.10 14:53:06