API実装ライフサイクル

8 API実装ライフサイクル

ドラフト状態のAPI実装が構成され、テストされたら、それを公開する準備が整いました。 APIの実装では、既存のバージョンを更新することができ、かつ時代遅れの実装は、ゴミ箱に移動することができ、APIが公開されることに加えて、新しいバージョンを作成することができるのと同じライフサイクルの段階を経ます。

API実装が公開された後は変更できません。実装をまだ構成およびテストしている場合は、ライフサイクルの次のフェーズの準備が整うまでドラフト状態にしておきます。

API実装のライフサイクルを調べる前に、ライフサイクル全体でアーティファクトがどのように相互に関連しているかを一般的に紹介したい場合は、「ライフサイクルの理解」を参照してください。

API実装の公開

「APIの実装」ページから実際の非モック・データを含む実装を公開することができます。実装はAPIとは独立して公開することができ、別々のバージョンを持つこともできます。これにより、API自体の更新を必要とせずに、マイナーな変更やバグ修正など、公開された実装に変更を加えることができます。

をクリックし、サイド・メニューから「開発 > API」を選択します。
パブリッシュする実装に関連付けられているAPIを選択します。
右側のセクションで「実装」を展開し、「管理」をクリックします。
「API実装」ページが表示されます:

図api_impl_publish.pngの説明

「APIの実装」ページの「依存性」セクションを展開すると、依存関係のリストが表示されます。実装に関連するAPI、および実装が呼び出すその他のAPIまたはコネクタがリストされています。依存関係がDraft状態、Published状態、または未解決であることがわかります。
実装を選択し、「公開」をクリックします。
依存関係の検索が実行されます。未解決の依存関係が見つかった場合、その実装を公開することはできません。問題を解決し、実装を再度公開してみてください。

図api_impl_publish_confirm.pngの説明

package.jsonファイルではなくOracle-Mobile-API-Versionヘッダーを通じてAPI依存関係が宣言されている場合、APIデザイナはヘッダーを通じて宣言された依存関係を認識せず、呼び出しAPIを公開するときに情報を要求しません。この場合、依存するAPIを自分で公開することを忘れないでください。
未公開の依存関係が見つかった場合は、「すべて公開」をクリックして、未公開のすべてのアーティファクトを公開します。
実装にすべての依存関係を公開しない場合は、Xをクリックして操作を取り消します。依存関係を個別に公開することも、実装を編集して削除することもできます。

API実装の新規バージョンの作成またはバージョンの更新

実装はAPIとは独立して公開することができ、別々のバージョンを持つこともできます。これにより、API自体の更新を必要とせずに、マイナーな変更やバグ修正など、公開された実装に変更を加えることができます。 DraftまたはPublished状態のAPI実装の新しいバージョンを作成できます。公開された実装を変更する場合は、新しいバージョンを作成する必要があります。

特定のバージョンが指定された実装を以前にアップロードしていて、その実装がまだDraft状態になっている場合は、バージョン番号を増やすことなくそのバージョンを置き換えることができます。これは、実装をアップロードし、実装をテストした後、変更を公開する前にさらに変更が必要であることがわかっている場合には望ましいことです。バージョンを公開した後、そのバージョンは最終バージョンです。

ドラフト状態の実装のバージョン番号を更新することもできます。両方のプロセスは同じです。実装のpackage.jsonファイルにversion属性を設定します。

package.jsonファイルを開き、version属性を変更します。たとえば、“version”:”1.0”を“version”:”1.1”に変更します。
変更された実装のzipファイルを、関連するAPIバージョンにアップロードします。

実装バージョンについて知るべき重要な点は次のとおりです:

実装バージョンはAPIバージョンとは独立して管理されます。 APIを公開すると、実装は自動的に公開されません。
新しいバージョンの実装をアップロードすると、そのAPIのデフォルト・バージョン(アクティブ実装)になります。「APIの実装」ページでデフォルトのバージョンを変更できます。
カスタムAPIのRouting_BindApiToImplポリシーは、APIバージョンと実装バージョン間の関連付けを定義します。

API実装をごみ箱に移動

API実装をゴミ箱に移動して削除します。後で実装が必要な場合は、ごみ箱からリストアすることができます。

をクリックし、サイド・メニューから「開発 > API」を選択します。
実装に関連するAPIを選択します。
APIナビゲーション・バーの「実装」をクリックします。
削除するドラフトAPI実装を選択します。
「ゴミ箱に移動」をクリックします。
実際の実装(模擬実装ではない)だけをごみ箱に移動することができます。現在のデフォルトの実装をゴミ箱に移動する場合は、実装の次の最新バージョンが自動的にデフォルトに設定されます。他の実装が存在しない場合、模擬実装がデフォルトになります。
依存関係の問題がなければ、確認ダイアログで「ごみ箱」をクリックします。

あなたや他の人が後でそれをリストアすると思われる場合は、このアイテムをゴミ箱に入れた理由を簡単に記入してください。

API実装のリストア

をクリックし、サイド・メニューから「開発 > API」を選択します。
実装に関連するAPIを選択します。
「ごみ箱」 ()をクリックします。
ゴミ箱の「実装」を選択します。
ごみ箱のアイテムのリストで、目的の実装でをクリックし、「ゴミ箱からリストア」を選択します。
競合がなければ、確認ダイアログで「リストア」をクリックします。

APIで使用されていた実装をリストアする場合、その実装はAPIのデフォルトの(アクティブな)実装としてリストアされません。 Implementationsページから実装をデフォルトとしてリセットする必要があります(APIを選択し、navbarの「実装」をクリックしてください)。

アーティファクトをリストアすると、アーティファクトが重複している場合にコンフリクトが発生する可能性があります。