OpenAPI生成Kotlin代码如何将描述等写入@Schema注解而非仅Javadoc?
openapi-generator原生支持该需求,只需调整配置即可实现,具体操作如下:
- 启用Swagger注解生成配置:你使用的Kotlin系列生成器(包括kotlin-spring、kotlin-jvm-client、kotlin-server等)均自带
swaggerAnnotations配置项,将该值设为true即可自动把OpenAPI规范中定义的类、字段的description、example、参数校验规则等元数据写入@Schema注解,同时会保留原有的Javadoc生成逻辑。
示例CLI生成命令:openapi-generator generate \ -i your_spec.yaml \ -g kotlin-spring \ -o ./output \ --additional-properties=swaggerAnnotations=true - 如果你使用的是v6.0+版本的openapi-generator,且需要适配Spring Boot 3/Jakarta命名空间的Swagger注解,可以额外添加
useSpringBoot3=true配置,生成器会自动使用io.swagger.v3.oas.annotations.media.Schema注解而非旧的javax包下的注解。 - 如果原生生成的注解逻辑不符合你的自定义需求,可以下载对应生成器的
model.mustache、pojo.mustache模板文件,手动调整注解的参数映射规则,生成时添加-t 本地模板目录参数指定自定义模板即可。
其他可选工具
如果不想使用openapi-generator,也可以选择以下工具实现相同需求:
- openapi-processor:专门针对JVM/Kotlin生态设计的OpenAPI生成工具,原生支持自定义注解生成规则,配置更轻量化
- JetBrains IDEA内置OpenAPI生成插件:可直接在IDE中配置注解映射规则,无需额外安装命令行工具
内容的提问来源于stack exchange,提问作者Serob
相关产品推荐
相关产品推荐

