Как вы используете 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

и даже больше...