Dataphin:API の管理

権限

• スーパー管理者はすべての API を管理できます。

• プロジェクト管理者は、自分のプロジェクト内の API を管理できます。

• API 所有者は、自分が所有する API を管理できます。

API リストへのアクセス

1. Dataphin ホームページの上部メニューで、[Services] > [API Studio] を選択します。

2. 左上隅でサービスプロジェクトを選択します。次に、左側メニューで、[API Service] > [API] を選択して、[API] リストページを開きます。

3. API を名前または ID で検索できます。[Submitted Today] や [My APIs] などのクイックフィルターも使用できます。または、操作タイプ、API タイプ、データソース、API グループ、最終送信時刻、モード、呼び出しモード、現在のステータス、または所有者によって API をフィルタリングできます。

   My APIs：このフィルターは、自分が所有する API を表示します。使用権限のみが付与されている API は含まれません。

4. API リストには、API とその詳細が表示されます。詳細には、名前と ID、API タイプ、データソース、呼び出しモード、モード (環境)、操作タイプ、現在のステータス、ランタイム環境、公開済みバージョン、リリース情報、データ更新頻度、API グループ、所有者、API に関連付けられているアプリケーションの数、権限情報、データ量が含まれます。

5. API の [Actions] 列で、次の操作を実行できます。ワークフロー API の場合、[Test] および [Version Management] 操作のみがサポートされます。

   アクション	説明
   [公開]	[Actions] 列の [Publish] をクリックするか、公開する API を選択して下部にある [Batch Publish] をクリックします。[Publish API] ダイアログボックスで、送信済みのバージョンを選択して API を本番環境に公開します。詳細については、「ステップ 2: APIの公開」をご参照ください。 説明 バージョンがすでに公開されている場合、システムは公開前に新しいバージョンに破壊的変更がないか検証します。この検証では、必須リクエストパラメーターの追加、リクエストパラメーターまたはレスポンスパラメーターの削除、リクエストパラメーターのデータ型の変更、呼び出しタイプの変更などの変更がチェックされます。 その後、システムは設定されたポリシーに基づいてリリースをブロックまたは許可します。詳細については、「サービスプロジェクトの作成」をご参照ください。 論理テーブルから作成された API は、一括公開をサポートしていません。 一括公開中に API のバージョンを選択しない場合、その API は公開されません。
   [編集]	[Actions] 列の [Edit] アイコンをクリックして、API 編集ページを開きます。 説明 デフォルトでは、API の最新バージョンの編集ページが開きます。別のバージョンを編集するには、ページの右上隅でバージョンを切り替えることができます。 API バージョンのステータスが「送信済み」または「ドラフト」の場合、ページの左上隅から別の API に切り替えることができます。現在のサービスプロジェクト内で API を名前または ID で検索できます。システムは、プロジェクトで最近アクセス (表示、編集、テスト、または作成) した最後の 9 つの API を表示します。 API の最新の公開済みバージョンを直接編集することはできません。代わりに、システムはそれに基づいて新しいバージョンを自動的に作成し、バージョン番号を提案します。バージョンの詳細を確認した後、[OK] をクリックして API バージョン作成ページに進みます。 API バージョンのステータスが「送信済み」または「ドラフト」の場合、その編集ページを直接開くことができます。
   [テスト]	[Actions] 列の [Test] アイコンをクリックすると、[Development] > [API] > [API Test] ページが開き、API の最新のテスト可能なバージョン (送信済みまたは公開済みのバージョン) が自動的に読み込まれます。 説明 テスト環境では、複数の API バージョンが共存し、同時にテストできます。これにより、異なるバージョンのパフォーマンスを比較し、最もパフォーマンスの高いものを公開できます。詳細については、「ステップ 1: APIのテスト」をご参照ください。
   [バージョン管理]	[Actions] 列の [More] アイコンをクリックし、[Version Management] を選択します。[Version Management] パネルでは、さまざまな API バージョンの編集、バージョン比較、削除、クローニングを行えます。 説明 ダウンストリームアプリケーションが呼び出す API ID を変更できない場合は、バージョニングを使用して API のデータソースやクエリ条件の変更を管理できます。新しいバージョンを開発してテストし、本番環境に公開して古いバージョンを上書きします。このプロセスにより、クライアント側の変更を回避できます。設定の詳細については、「APIの複数バージョン管理」をご参照ください。
   [API プロパティの変更]	[Actions] 列の [More] アイコンをクリックし、[Modify API Properties[] を選択します。[Modify API Properties[] ダイアログボックスで、API の名前、API グループを変更できます。API 名の命名規則は、新しい API を作成するときと同じです。
   [所有者の引き継ぎ]	[Actions] 列の [More] アイコンをクリックし、[Transfer Owner] を選択します。[Transfer Owner] ダイアログボックスで、[Personal Account] を選択します。API は、同じプロジェクト内の別の開発者またはプロジェクト管理者に引き継ぐことができます。[OK] をクリックして引き継ぎを完了します。
   [API のクローン]	[Actions] 列の [More] アイコンをクリックし、[Clone API] を選択します。[Clone API] ダイアログボックスで、クローンするバージョンを選択して [OK] をクリックします。この操作を実行すると、API 作成ページが開き、詳細を変更できます。 説明 API をクローンすると、選択したバージョンのすべての情報を含む新しい API が作成されます。API 名はプロジェクト内で一意である必要があるため、送信エラーを回避するには新しい API の名前を変更する必要があります。 デフォルトでは、システムはステータスが「送信済み」または「公開済み」の最新バージョンを選択します。API のどのバージョンでも、そのステータスに関係なくクローンできます。
   [削除]	[Actions] 列の [More] アイコンをクリックし、[Delete] を選択します。API に依存関係がない場合は、[Delete API] ダイアログボックスで [OK] をクリックして削除します。アプリケーションに API への権限が付与されている場合、または API が複合 API によって参照されている場合は、まず権限を取り消すか参照を削除してから、API を削除する必要があります。

API バージョン管理

API バージョンの作成

ワークフロー API は、このインターフェイスでの新しいバージョンの作成をサポートしていません。ワークフロー API の新しいバージョンを作成するには、[R&D] > [Data Development] > [Workflow] に移動し、対象のワークフローを選択します。

1. API リストページで、[Actions] 列の [Version Management] をクリックして [Version Management] パネルを開きます。

2. [Version Management] パネルで [Create Version] をクリックし、次のパラメーターを設定します。

   パラメーター	説明
   [既存バージョンに基づく]	デフォルトでは最新バージョンが選択されています。API の既存のバージョンを、そのステータスに関係なく選択できます。
   [バージョン番号]	システムがバージョン番号を提案しますが、変更することもできます。各 API バージョンには、以前のバージョンとの比較を可能にするために、一意のバージョン番号が必要です。バージョン番号は最大 64 文字で、API 内で一意である必要があります。

3. [Confirm] をクリックして [Create API Version] ページを開き、API パラメーターを設定します。

4. 情報が正しいことを確認した後、[Submit] をクリックして新しい API バージョンを作成します。その後、API リストページから API を管理できます。

API バージョンの管理