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

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

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

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

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

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

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

始める前に

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

手順

ホームページで、新しいバージョンを作成するAPIに移動します。
必要であればリストを名前でフィルタリングします。
コピーしたいバージョンの横にあるボタンをクリックし、[Create a new version from <version>](新しいバージョンを作成)をクリックします。
[Version] (バージョン)フィールドに新しいバージョンを入力します。
オプション: [Copy sharing settings] (共有設定をコピー)チェックボックスをオフにすると、共有設定がリセットされます。
デフォルトでは、ソースバージョンが他のユーザーやグループと共有されている場合は新しいバージョンにも同じ設定がコピーされます。このチェックボックスをオフにすると、新しいバージョンはAPIレベルで共有設定を継承します。詳細については、APIの特定のバージョンを共有をご覧ください。
オプション: GitHub設定を編集します。
デフォルトでは、ソースバージョンがGitHubにリンクされていると新しいバージョンにも同じ設定がコピーされます。ブランチとパスを変更するか、[Copy GitHub settings] (GitHubの設定をコピー)チェックボックスをオフにして新しいバージョンのGitHubインテグレーションを無効にします。必要であれば有効にして設定することもできます。詳細については、APIのバージョンをGitHubにプッシュするをご覧ください。
[Create]をクリックします。

タスクの結果

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

APIバージョンを削除

始める前に

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

手順

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

情報メモ注: バージョンは[API Portal]にドキュメンテーションが公開されていると、削除できません。削除する前に、公開を解除するか、非公開としてマークする必要があります。詳細については、 APIドキュメントの管理をご覧ください。
[Are you sure?] (よろしいですか?)をクリックして確認します。

タスクの結果

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

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

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

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