SwaggerHub - バージョン管理

API 定義の管理

» SwaggerHub: (主な機能に戻る)

市場のツールはますます API 定義を出発点として利用しています。多くの人が、API の定義を API の「本当のソース」とみなしています。つまり、定義を慎重に管理して、さまざまなバージョンを適切に格納して制御する必要があります。

バージョン管理

SwaggerHub には、API 定義のバージョンを最大 25 個まで設定できます。これにより、API コンシューマー向けにクリーンな公開バージョンを維持しながら、定義を継続的に洗練して拡張することができます。

たとえば、API 定義の次期バージョンで共同作業者と作業している場合、統合する変更をマージできる安定したバージョンを維持しながら、全員が共同作業するコラボレーション バージョンを作成することができます。

API 定義をバージョン管理する方法はいくつかあります。

  • 未パブリッシュの定義を別のバージョンとして保存する。
  • パブリッシュされた定義を変更した後、新しいバージョンにする (これにより、パブリッシュされたバージョンは保持されます)。
  • 新しい API/バージョンを分岐する

パブリッシュ/未パブリッシュ

パブリッシングについて: SwaggerHub Registry に他の人が参照できるように API 定義の準備ができていれば、パブリッシュできます。API 定義を公開すると効果的にロックされ、その時点以降に行った変更はすべて別のバージョンとして保存されます。 その定義を作成する過程で共同編集者を追加した場合、共同編集者はパブリッシュ済みのバージョンを変更することもできなくなります。

しかし、誰もが [元に戻す] ボタンを望んでいます。そこで SwaggerHub では、その機能を装備しました。もし、考えを変えて、その API 定義を元に戻して修正を加えたい場合は、その API 定義をパブリッシュしないことを選択できます。API 定義をパブリッシュしないと、SwaggerHub Registry からその定義が削除されます。そのため、公開された調査なしで変更を続けることができます。

GitHub にプッシュ

SwaggerHub Registry に API 定義を保存して管理するだけではありません。API 定義を独自のリポジトリに残りの資産とともに保存することが重要です。そのため、協力者からの貢献をマージしてコミットする準備ができたら、[Push to GitHub] オプションを使用して、現在のバージョンの API 定義をプライベートまたは共有リポジトリにコミットできます。

 

ページ トップに戻る