Redoc

OpenAPI（Swagger）仕様ファイルから美しく、レスポンシブでインタラクティブなドキュメントを生成するオープンソース API ドキュメントビューアーです。

デプロイ後にできること

1. ドメインにアクセス — Redoc でレンダリングされたデフォルトの Petstore API ドキュメントを確認
2. 独自の仕様をロード — SPEC_URL 環境変数で OpenAPI/Swagger JSON または YAML 仕様の URL を指定
3. 3パネルレイアウトを探索 — 左メニュー、中央コンテンツ、右コードサンプルをナビゲート
4. API を検索 — 内蔵検索でエンドポイントやスキーマを素早く検索
5. ディープリンクを共有 — 特定のエンドポイントやスキーマに直接リンクする URL をコピー

主な機能

• メニュー、コンテンツ、コードサンプルを含む3パネルレスポンシブレイアウト
• OpenAPI 3.1、3.0、Swagger 2.0 仕様をサポート
• 複数言語サンプル付きのインタラクティブなリクエスト/レスポンス例
• すべてのエンドポイントとスキーマにわたる内蔵検索機能
• 特定のオペレーション、タグ、スキーマへのディープリンク
• 自動コードサンプル生成
• SEO のためのサーバーサイドレンダリングサポート
• カスタマイズ可能なテーマとブランディングオプション
• 説明での Markdown サポート
• モバイルフレンドリーなレスポンシブデザイン

ライセンス

MIT — GitHub