複数のバージョンでの作業

API Designerを使えば同じAPI定義の複数のバージョンで作業できるため、APIのライフサイクルの管理に役立ちます。次の操作が可能です:

既存のAPIバージョンを本番環境で維持しつつ、重要な変更や画期的な変更を新しいバージョンに導入できます。
公開されているバージョンを可視化して管理できます。
APIへの変更をデザインする際の柔軟性が向上します。

APIの新しいバージョンを作成すると、すべてのコンテンツが新しいバージョンにコピーされ、どのバージョンも他のバージョンに影響を与えることなく独立して変更できるようになります。

API Designerホームページには、所有するすべてのAPIと共有するAPIの全バージョンが表示されます。

新しいAPIバージョンの作成

既存のAPI定義の新しいバージョンを作成

APIの所有者か、少なくとも1つのAPIバージョンのエディターであること。

ホームページで、新しいバージョンを作成するAPIに移動します。
必要であればリストを名前でフィルタリングします。
コピーしたいバージョンの横にあるボタンをクリックし、[Create a new version from <version>](新しいバージョンを作成)をクリックします。
新しいバージョンを入力します。
[Create] (作成)をクリックします。

新しいバージョンのAPIがソースバージョンと同じコンテンツで作成されます。デフォルトではモックとドキュメンテーションが無効になっています。

APIバージョンの削除

APIの所有者か編集者であること。

ホームページで、削除したいバージョンの横にあるボタンをクリックし、[Delete] (削除)をクリックします。
[Delete] (削除)をクリックして確定します。

選択されたバージョンで削除されます。API全体を削除する場合は、それぞれのバージョンを削除する必要があります。

バージョンコンテンツのインポート

既存のコントラクトからコンテンツを API バージョンにインポートし、現在のコンテンツを置き換えるか、統合します。

APIの所有者またはAPIバージョンの編集者である必要があります。

この機能を使用すると、新しいバージョンを作成せずに外部のコントラクトファイルからバージョンを更新できます。インポート中もバージョン識別子は保持されます。

これは、API Designerで新しいAPIを作成する定義のインポートとは異なります。

更新対象となるバージョンの[Import version content] (バージョンコンテンツのインポート)を開きます。
この操作には、次の場所からアクセスできます。
- ホームページで、対象のバージョンの横にあるメニューボタンをクリックし、[Import version content] (バージョンコンテンツのインポート)をクリックします。
- ホームページでバージョンを選択して詳細ペインを開き、[Import version content] (バージョンコンテンツのインポート)をクリックします。
- バージョンエディターで、[Edit] (編集) > [Import version content] (バージョンコンテンツのインポート)をクリックします。
インポートするコントラクトの形式とソースを選択します。
コントラクトは、ローカルファイル、URL、またはダイアログボックスに直接貼り付けたテキストからインポートできます。
[Behavior] (動作)で、インポートしたコンテンツの適用方法を選択します。
- 置換: 現在のすべてのコンテンツをインポートしたコントラクトで上書きします。API名、バージョン識別子、仕様バージョンは保持されます。
- マージ: インポートしたコンテンツを既存のバージョンコンテンツと統合します。API名とバージョン識別子は保持されます。インポートしたエレメントが既存のエレメントと同じ名前を持つ場合、そのエレメントは_mergeサフィックスを付けて名前が変更されます(例: User_merge)。重複するベースURLおよびメディアタイプはスキップされます。
[Import] (インポート)をクリックします。

更新されたコンテンツが適用された状態で、バージョンエディターが開きます。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください