Swagger UI 中如何设置示例标签为默认显示

在 Swagger UI 的使用过程中，许多开发者发现从某个版本开始，API 文档的响应部分默认显示的是模型/架构(Model/Schema)标签，而不是之前的示例(Examples)标签。这一变化虽然不影响功能，但对于那些更关注实际响应示例而非数据结构的开发者来说，可能会带来一些不便。

问题背景

Swagger UI 是一个流行的 API 文档工具，它能够根据 OpenAPI/Swagger 规范自动生成交互式文档界面。在展示 API 响应时，Swagger UI 提供了多个标签页，主要包括：

1. 示例(Examples)标签：展示实际的响应示例数据
2. 模型/架构(Model/Schema)标签：展示响应数据的结构定义

在较新版本的 Swagger UI 中，默认会显示模型/架构标签，而许多开发者更习惯或更希望默认显示示例标签，因为示例数据更直观，能更快理解 API 的实际响应格式。

解决方案

要解决这个问题，关键在于理解 Swagger UI 的配置选项。Swagger UI 提供了一个名为 defaultModelRendering 的配置项，它控制着默认显示的标签类型。

配置方法

1. 移除默认模型渲染设置：如果你在初始化 Swagger UI 时显式设置了 defaultModelRendering: 'model'，这会导致默认显示模型标签。移除这个设置即可恢复默认行为。

2. 显式设置示例为默认：虽然 Swagger UI 没有直接提供设置示例为默认的选项，但通过不设置 defaultModelRendering 或将其设置为其他值，可以实现示例标签默认显示的效果。

推荐配置

以下是推荐的 Swagger UI 初始化配置：

SwaggerUI({
    spec: apiSpec,
    defaultModelsExpandDepth: -1,
    dom_id: '#container',
    showExtensions: true,
    deepLinking: true
})

注意这里没有包含 defaultModelRendering 配置项，这样 Swagger UI 会使用其内部默认行为，通常会优先显示示例标签。

技术原理

Swagger UI 的标签显示逻辑是由其内部渲染引擎控制的。defaultModelRendering 配置项接受以下可能的值：

• 'model'：强制默认显示模型标签
• 'example'：理论上应该显示示例标签，但在实际测试中效果可能不一致
• 不设置或设置为其他值：使用 Swagger UI 的默认行为

在大多数情况下，不设置此选项或将其设置为非 'model' 的值，Swagger UI 会优先显示更用户友好的示例标签。

最佳实践

对于 API 文档开发者，建议：

1. 保持配置简洁：除非有特殊需求，否则不要过度配置 Swagger UI
2. 测试不同版本：Swagger UI 不同版本可能有细微差异，建议在实际环境中测试配置效果
3. 考虑用户习惯：大多数 API 使用者更关注实际示例而非数据结构模型

通过合理配置 Swagger UI，开发者可以创建出既美观又实用的 API 文档界面，提升开发者的使用体验。