1. Homepage
  2. Design Center
  3. API Designer

  4. GitHub Synchronization

GitHub Synchronization

API 仕様設計者の多くは、複数のオーサリングツールやバージョン管理ツールを使用しています。この結果、複数の異なる仕様バージョンの管理が必要になることがあります。

GitHub Synchronization は、複数の場所に存在する API 仕様を管理するためのバージョン管理ツールです。GitHub Synchronization を使用すると、API Designer と自分の GitHub リポジトリの間での双方向同期を実現し、API プロジェクトへの変更を自動的に捕捉して、同期対象として選択してある GitHub リポジトリに変更を送信することができます。また、同期対象の GitHub リポジトリでの変更を自動的に API プロジェクトに伝播します。

この双方向フローにより、信頼できる唯一の情報源が常に GitHub であるコラボレーション環境で API Designer を活用できます。制限から解放された設計者は、同じコンテンツを共有して、同じコンテンツに貢献できます。

GitHub Synchronization と API Designer を併用することで、以下の作業が可能になります。

  • 既存の API プロジェクトと同期した GitHub リポジトリを作成する。

  • 新規 GitHub リポジトリと同期した新規 API プロジェクトを作成する。

  • 既存のリモート新規 GitHub リポジトリと同期した新規 API プロジェクトを作成する。

プル要求のオープン、分岐の差分の表示、同期状況の表示など、GitHub 特有のアクションを実行するには、GitHub UI を使用します。

関連情報