Redocly

Redoclyは、プロフェッショナルな開発者ポータルの構築を支援するAPIドキュメントプラットフォームです。APIを記述したOpenAPIファイルから始め、Redoclyがそれをクリーンで読みやすいドキュメントに変換し、例やインタラクティブな機能を提供します。

このプラットフォームは複数の製品が連携して動作します。Reuniteはチームがコンテンツを作成・レビューする場所です。Realmは最終的なドキュメントをユーザーに提供します。RedocはAPIリファレンスドキュメントをレンダリングするオープンソースエンジンです。ReefはすべてのAPIを一つのカタログで整理・発見するのに役立ちます。

基本的なドキュメントジェネレーターとは異なり、Redoclyは完全な開発者ポータルを提供します。APIリファレンスに加えて、ガイドやチュートリアル、カスタムページを追加できます。すべてはバージョン管理されており、API定義を変更すると自動的に更新されます。

Redoclyの使い始めは簡単です。ドキュメントを作成する手順は以下の通りです：

• Redoclyのアカウントにサインアップし、ウェブサイトで無料トライアルを開始します。

• GitHub、GitLab、またはAzure DevOpsからコードリポジトリを接続し、OpenAPIファイルを自動的に同期します。

• OpenAPI定義ファイルをアップロードするかリンクします。RedoclyはOpenAPIバージョン2.0、3.0、3.1に対応しています。

• 色、フォントを変更したり、ブランドに合わせてロゴを追加したりして外観をカスタマイズします。

• Markdownを使ってガイド、チュートリアル、はじめにセクションなどの追加コンテンツページを作成します。

• 組み込みのエディターを使って変更を記述・プレビューし、公開前に確認します。

• API定義をリポジトリで変更するたびにドキュメントが更新されるよう、自動ビルドを設定します。

• カスタムドメインを設定して、独自のウェブサイトアドレスでドキュメントをホストします。

• OpenAPIファイルからの自動APIドキュメント生成

• ナビゲーションと例を備えた美しい三面レイアウト

• エンドポイントをテストするためのインタラクティブなAPIコンソール

• カスタムブランディングとスタイリングオプション

• 自動更新を備えたGitワークフロー

• マルチバージョンAPIサポート

• AI機能を活用した高度な検索

• ガイドやチュートリアルのためのMarkdownサポート

• チームコラボレーションとレビュー機能

• カスタムドメインホスティング込み