Redocly - 🐾 Nekonote

Redocly

https://avatars.githubusercontent.com/u/32099856?s=200&v=4#.png

OpenAPI 用の定義を活用した APIドキュメンテーションのソリューションを開発する企業、サービス、ツール

CLIとしてのRedocly

OpenAPI v3 と Swagger のAPI定義を元にドキュメントを生成したり、定義ファイルをバンドルできる

TypeScript で開発されており、実行に際して Java などの外部依存を必要としない。

実行できる機能の一部を以下に紹介する。

なお npx を使用して実行する場合は npx @redocky/cli からコマンドを始めると良い。

code:sh

# index.yml を元に定義ファイルをバンドルする

redocly bundle ./path/to/index.yml --output ./tmp/bundled.yml

# 定義ファイルを元にHTMLによるドキュメントを閲覧する

redocly preview-docs ./path/to/index.yml

# 定義ファイルを元にHTMLによるドキュメントを生成する

redocly build-docs ./path/to/index.yml --output ./path/to/out

その他提供されているサブコマンドの一覧は以下を参照のこと

Redocly CLIから提供されるドキュメントの生成機能は、同社の開発する Redoc によるもの。