【リドック】
ReDoc とは?
最終更新:
💡 APIドキュメントを雑誌のように美しく仕上げる職人
OpenAPI(旧Swagger)の定義からAPIリファレンスを生成するオープンソースツール。Redocly社が開発し、3カラムのレイアウトで読みやすいドキュメントを作成できる。
📌 このページのポイント
3カラムレイアウトってどんな感じなの?
導入は簡単なの?
カスタマイズはどのくらいできるの?
テーマ設定で色やフォントなどを変更できるよ。x-tagGroupsという拡張を使えば、サイドメニューのタグをカテゴリごとにまとめることもできるんだ。ロゴはx-logoという拡張で指定できるよ
もっと詳しく知りたい人へ
ReDocでAPIのリクエストを実際に送って試せる?
オープンソース版(Redoc CE)のREADMEに並ぶ機能は、3カラムの表示、検索、x-tagGroupsによるメニューのグループ化などで、APIを呼び出すコンソールは含まれていないよ。試しながら読みたい場合は、Swagger UIのように「APIのリソースを見て操作できる」ツールを併用するか、開発元の有償製品の機能を確認しよう。
📖 おまけ:英語の意味
「ReDoc」 = 製品名
💬 名前の由来を説明した公式の資料は見当たらないよ。開発元はRedocly社で、今の公式表記は「Redoc」(オープンソース版はRedoc CE)なんだ