SpringDoc OpenAPI 3.1版本枚举类型显示问题解析

在SpringDoc OpenAPI项目从2.8.5升级到2.8.6版本后，许多开发者注意到一个显著的变化：当使用OpenAPI 3.1规范时，枚举类型(enum)和示例(example)的显示方式发生了改变，新的显示格式在某些情况下显得不够直观。

问题现象

在2.8.5版本中，枚举值会以清晰简洁的列表形式展示，每个枚举值单独显示。而在2.8.6及更高版本中，枚举值被显示为带有索引前缀的格式(如"#0=value1")，这种显示方式增加了视觉复杂度，降低了可读性。

类似的显示变化也影响到了示例(example)部分。原本直观的示例展示被替换为更技术化的表示形式，这对于API文档的使用者来说可能不够友好。

根本原因

这一变化源于两个关键因素：

1. OpenAPI规范版本变更：SpringDoc 2.8.6将默认的OpenAPI规范版本从3.0升级到了3.1。不同版本的规范在UI渲染上有不同的处理方式。

2. Swagger UI版本更新：2.8.6版本同时升级了集成的Swagger UI组件，新版本的Swagger UI对OpenAPI 3.1规范的渲染方式进行了调整。

OpenAPI 3.1规范本身对枚举类型的定义和处理并没有本质变化，但Swagger UI选择以不同的方式展示这些信息。这种改变可能是为了更准确地反映规范中的某些技术细节，但客观上降低了文档的可读性。

解决方案

对于希望保持原有显示风格的开发者，有以下几种选择：

1. 显式指定OpenAPI 3.0规范：在应用配置中添加springdoc.api-docs.version=openapi_3_0，强制使用3.0版本的规范渲染方式。

2. 等待Swagger UI更新：这个问题本质上属于Swagger UI的渲染策略，未来版本可能会改进显示方式。

3. 自定义UI组件：对于有特殊需求的项目，可以考虑定制或替换默认的Swagger UI组件。

技术建议

在实际项目中，选择OpenAPI规范版本时应考虑以下因素：

• 如果需要使用OpenAPI 3.1特有的功能，如更好的JSON Schema支持，则接受新的显示方式
• 如果文档可读性是首要考虑，且不需要3.1特性，可以暂时停留在3.0规范
• 对于新项目，建议评估显示效果对API消费者的影响

值得注意的是，这种显示变化只影响文档的呈现方式，不会影响API的实际行为和客户端代码生成功能。开发团队可以根据项目具体情况权衡利弊，选择最适合的方案。