从OpenAPI生成Spring代码时示例字段缺失问题求助

1. 确认OpenAPI示例定义的兼容性 #

你的OpenAPI语法在Swagger Editor中正常显示，说明基础定义合法，但部分版本的OpenAPI Generator对通过$ref引用的组件示例支持不完善。可以先尝试将示例内联到响应中，验证是否能被生成器识别：

responses:
  '200':
    description: Successful operation
    content:
      application/json:
        schema:
          type: string
        examples:
          someExample:
            summary: Test
            value: 'test'

2. 调整OpenAPI Generator Maven插件配置 #

你的插件版本（6.6.0）默认不会主动生成示例相关的代码注释，需要在<configOptions>中添加启用参数：

<configOptions>
    <interfaceOnly>true</interfaceOnly>
    <dateLibrary>java8-localdatetime</dateLibrary>
    <!-- 启用示例生成逻辑 -->
    <useExamples>true</useExamples>
    <!-- 确保示例被写入API接口注释 -->
    <apiDocs>true</apiDocs>
</configOptions>

useExamples参数会触发生成器将示例信息嵌入到生成的接口注释中，后续Swagger UI就能读取这些内容并展示。

3. 检查Swagger UI的显示配置 #

如果生成代码后Swagger界面仍不显示示例，需要确认SpringDoc（或Swagger UI）的配置是否开启了示例展示：
在application.yml中添加以下配置：

springdoc:
  swagger-ui:
    show-extensions: true
    show-common-extensions: true

4. 升级OpenAPI Generator版本 #

6.6.0版本存在部分针对字符串类型响应示例的处理bug，升级到最新稳定版（如7.6.0）可修复此类兼容性问题：

<version>7.6.0</version>

内容的提问来源于stack exchange，提问作者Роман Янин