RapiDoc 中如何展示独立的 Schema 定义模块

在 API 文档工具 RapiDoc 中，开发者有时需要单独查看 API 的 Schema 定义部分。与 Swagger UI 不同，RapiDoc 默认不会将 Schema 定义单独列出展示，这可能会给需要集中查阅数据模型的开发者带来不便。

解决方案

RapiDoc 提供了一个配置选项 show-components，当设置为 true 时，可以在文档中显示独立的 Schema 定义模块。需要注意的是，这一功能仅在 focused 渲染模式下可用。

实现方法

要启用 Schema 定义展示功能，只需在 RapiDoc 配置中设置：

<rapi-doc show-components="true" render-style="focused"></rapi-doc>

功能特点

1. 集中查看：开发者可以在一个独立区域查看所有定义的 Schema，便于理解和对比不同数据模型
2. 快速导航：在大型 API 文档中，可以快速定位到特定的数据模型定义
3. 完整性检查：方便检查所有定义的数据模型是否完整和一致

适用场景

• API 设计评审时快速查看所有数据模型
• 需要理解复杂 API 的数据结构关系时
• 在开发过程中需要参考多个数据模型定义时

注意事项

1. 该功能仅在 focused 渲染模式下有效
2. 在默认或其他渲染模式下，即使设置 show-components="true" 也不会显示独立 Schema 模块
3. 对于简单的 API 文档，可能不需要启用此功能

通过合理使用这一功能，可以显著提升大型 API 文档的可用性和开发者的工作效率。