Repolode
投稿する
Redocly

Redocly/redoc

OpenAPI、Swagger、AsyncAPI、GraphQLの定義から、レスポンシブな3ペイン構成のAPIリファレンスサイトを生成するオープンソースツール。

代替できる製品:SwaggerUI

GitHub で見る公式サイト
スター
25,970
フォーク
2,404
未解決の Issue
366
最終コミット
15 時間前

これは何？

RedocはAPI定義ファイルから、ナビゲーション可能なドキュメントページを生成します。OpenAPI 3.2、3.1、3.0、Swagger 2.0に対応し、AsyncAPI 3.xとGraphQL SDLも扱えます。フォーマットは自動的に判別されます。標準レイアウトは3ペイン構成で、左側に検索バーとナビゲーションメニュー、中央にドキュメント、右側にリクエストとレスポンスの例を表示します。

Redocにはいくつかの利用方法があります。npxでRedocly CLIを使って静的なHTMLファイルを生成したり、spec URLを読み込むカスタム要素をHTMLページに埋め込んだり、Reactコンポーネントとしてレンダリングしたりできます。CSS変数でテーマを設定でき、ダークモードにも対応しています。また、x-logo、x-tagGroups、x-codeSamplesなどのOpenAPI拡張を読み込み、出力をカスタマイズできます。

このプロジェクトはRedoclyがメンテナンスしており、ホスト型の商用版ではtry-itパネル、モックサーバー、lint機能などが追加されます。

主な機能

  • 01OpenAPI 3.2/3.1/3.0およびSwagger 2.0の定義をレンダリング
  • 02AsyncAPI 3.xとGraphQL SDLに対応し、フォーマットを自動判別
  • 03ナビゲーションが連動する、レスポンシブな3ペインレイアウト
  • 04CSS変数によるダークモードとテーマ設定
  • 05HTMLタグ、Reactコンポーネント、Redocly CLIコマンド、Dockerイメージとして利用可能

ユースケース

  • OpenAPIファイルから公開APIのリファレンスドキュメントを作成する
  • 既存のReactサイトや静的HTMLサイトにAPIドキュメントを埋め込む
  • オフライン利用や社内共有向けに、単体で動作するHTMLファイルを生成する

クイックスタート

  1. 1

    npxでOpenAPIファイルからドキュメントを生成します（Nodeが必要です）

    npx @redocly/cli build-docs openapi.yaml
  2. 2

    生成されたredoc-static.htmlファイルをブラウザーで開きます

使う前に知っておきたいこと

  • Community Editionには、Try-itパネル、モックサーバー、SOAPサポートなどの機能がありません。これらはホスト版のRedocでのみ利用できます。
  • Redocはデフォルトで匿名の利用状況データとパフォーマンスデータを収集するため、オプトアウトするにはdisable-telemetryまたはdisableTelemetryを設定する必要があります。

トピック

#api-documentation#openapi#swagger#documentation-generator#asyncapi#graphql#react#documentation-tool#hacktoberfest#openapi-specification

よくある質問

redoc とは？
OpenAPI、Swagger、AsyncAPI、GraphQLの定義から、レスポンシブな3ペイン構成のAPIリファレンスサイトを生成するオープンソースツール。 RedocはAPI定義ファイルから、ナビゲーション可能なドキュメントページを生成します。OpenAPI 3.2、3.1、3.0、Swagger 2.0に対応し、AsyncAPI 3.xとGraphQL SDLも扱えます。フォーマットは自動的に判別されます。標準レイアウトは3ペイン構成で、左側に検索バーとナビゲーションメニュー、中央にドキュメント、右側にリクエストとレスポンスの例を表示します。
redoc は無料で使えますか？ライセンスは？
redoc は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
redoc は今もメンテナンスされていますか？
活発にメンテナンス中。redoc の最終コミットは 2026年10月20日 です。
redoc は何に使えますか？
OpenAPIファイルから公開APIのリファレンスドキュメントを作成する 既存のReactサイトや静的HTMLサイトにAPIドキュメントを埋め込む オフライン利用や社内共有向けに、単体で動作するHTMLファイルを生成する
redoc のインストール方法は？
npxでOpenAPIファイルからドキュメントを生成します（Nodeが必要です）: npx @redocly/cli build-docs openapi.yaml 生成されたredoc-static.htmlファイルをブラウザーで開きます
redoc はどこで入手できますか？
ソースコードとインストール手順は GitHub にあります：https://github.com/Redocly/redoc

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト