バージョンを管理する

このページは ApigeeApigee ハイブリッドに適用されます。

バージョンは、明確に定義された API のインターフェースです。これにより、アプリケーションの安定した利用が可能になります。1 つの API に複数のバージョンを用意できます。

API は複数のデプロイメントを持つことができます。各デプロイメントは異なるバージョンを持つことができます。

バージョンは、編集権限を持つユーザーが API を登録するときに API と関連付けられます。また、デプロイメントを追加または編集するときにデプロイメントと関連付けられます。

[Versions] タブ。クリックして画像を拡大
API Registry スキーマを表示する

次に、API Hub API、バージョン、デプロイメント、仕様の関係を示します。

alt_text
リファレンス 項目 説明
レジストリ レジストリは、API カタログとしてサービスを提供する API のコレクションです。
バージョン 1 つの API に複数のバージョンを作成することもできます。バージョンは、クライアントが API の呼び出しに使用できる、安定したインターフェースに対応している必要があります。これらのバージョンのいずれかを推奨バージョンとして指定できます。semver の観点では、バージョンをメジャー バージョンにすることをおすすめします。
デプロイ API は、複数のステージング環境やリージョンなど、複数のデプロイメントを持つことができます。デプロイメントとは、ユーザーが API にアクセスできる場所(アドレス)です。これらのデプロイメントの 1 つが推奨デプロイメントになります。
仕様 API バージョンは、正式な API 仕様に従って記述することを推奨しますが、必須ではありません。これらの仕様は、多くの場合に異なる API 仕様の形式を使用しています。これらの仕様形式のいずれかをメインにできます。つまり、このバージョンの他の仕様がこの仕様から派生しています。
リビジョン
  • デプロイメントには変更履歴があります。デプロイメント リビジョンは、デプロイメントの特定のインスタンスを表します。デプロメントイから提供される API 実装が変更されると、1 つ以上の仕様リビジョンを参照できます。
  • 仕様には変更履歴があります。仕様のリビジョンは、仕様の後続のインスタンスを表し、通常は仕様の内容に対する互換性を損なわない変更を表します。semver では、リビジョンはマイナー バージョンまたはポイント バージョンに対応している場合があります。

バージョンを追加する

バージョンを追加するには:

  1. Google Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動

    デフォルトでは、[APIs] リストページが表示されます。

  2. [APIs] リストから API 行をクリックします。デフォルトでは、[Overview] タブが表示されます。
  3. [Versions] タブを選択します。
  4. [Add version] をクリックします。
  5. 詳細を指定します。
    • ID を入力します。小文字、数字、ハイフン(-)のみ使用できます。たとえば、v1、v1、1、1-0-0 などです。
    • バージョンを入力します。任意の文字を使用できます。
    • [API ライフサイクル ステージ] を選択します。
    • 終了予定:
      • リストから [予定] を選択します。
      • [予定] が [最小日付] の場合は、日付を指定します。
      • [予定] が [確定した日付] の場合は、[日付] を指定します。
  6. [保存] または [キャンセル] をクリックします。

バージョンを編集する

バージョンを編集するには:

  1. Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動

    デフォルトでは、[APIs] リストページが表示されます。

  2. [APIs] リストから API 行をクリックします。デフォルトでは、[Overview] タブが表示されます。
  3. [Versions] タブを選択します。
  4. バージョンの横にある その他)> [編集] をクリックします。
  5. 必要に応じて変更を行います。
  6. [保存] または [キャンセル] をクリックします。

バージョンを削除する

バージョンを削除するには:

  1. Cloud コンソールで、[API Hub] ページに移動します。

    [API Hub] に移動

    デフォルトでは、[APIs] リストページが表示されます。

  2. [APIs] リストから API 行をクリックします。デフォルトでは、[Overview] タブが表示されます。
  3. [Versions] タブを選択します。
  4. バージョンの横にある その他) > [削除] をクリックします。
  5. 確認のプロンプトで [削除] または [キャンセル] をクリックします。