如何使用 reDoc 处理多个文件

Question

我的 API 文档变得相当大，我想知道是否可以将文件分成openapi.yml单独管理的块，而不是将其全部放在一个文件中，然后让 reDoc（或其他一些工具）将其组合起来，然后生成 HTML 站点。

Answer 1

Redoc 有自己的“Redoc CLI”工具npm @redocly/cli

查看他们的教程https://github.com/Redocly/openapi-starter

使用此工具您可以：

1. 使用一个命令分割您的实际文档（路径、组件、参数、模式）

redocly split openapi.yaml --outDir openapi

2. lint 它们（单独的文件或最终文件）

redocly lint openapi/openapi.yaml

3. 预览（更改时热重载）

redocly preview-docs openapi/openapi.yaml

4. 并在生产准备就绪时将它们合并回来

redocly bundle openapi/openapi.yaml -o openapi.yaml

甚至更多...