API を作成した後、API バージョンを管理したり、API 所有者を変更したりできます。このトピックでは、API を管理する方法について説明します。
権限の説明
スーパー管理者はすべての API を管理できます。
プロジェクト管理者は、自分が所有するプロジェクトの API を管理できます。
API 所有者は、自分が所有する API を管理できます。
API リストのエントリ
Dataphin ホームページの上部ナビゲーションバーで、[サービス] > [API 開発] を選択します。
左上隅でサービスプロジェクトを選択します。次に、左側のナビゲーションウィンドウで、[API サービス] > [API] を選択して [API] リストページに移動します。
API を名前または ID で検索できます。また、クイックフィルター [本日サブミットされた API] または [マイ API] を使用したり、操作タイプ、API タイプ、データソース、API グループ、最終サブミット時間、パターン、呼び出しモード、現在のステータス、またはオーナーでフィルターしたりすることもできます。
マイ API: 所有している API です。権限をリクエストした API は含まれません。
API リストには作成された API が表示され、各 API の名前と ID、API タイプ、データソース、呼び出しモード、パターン (環境)、操作タイプ、現在のステータス、ランタイム環境、公開済みバージョン、公開情報、データ更新頻度、API グループ、オーナー、関連付けられたアプリケーションの数、権限情報、データボリュームなどの詳細が含まれます。
ターゲット API の操作列で、次の操作を実行できます。
操作
説明
公開
操作列の [公開] をクリックするか、公開する API を選択して下部の [一括公開] をクリックします。[API 公開] ダイアログボックスで、公開する送信済みバージョンを選択して、API を本番環境に公開します。詳細については、「手順 2: API を公開する」をご参照ください。
説明バージョンが既にオンラインで公開されている場合、新しいバージョンがオンラインで公開されるときにパラメーターが検証されます。検証には、必須リクエストパラメーターの追加、リクエストパラメーターの削除、レスポンスパラメーターの削除、リクエストパラメーターのデータ型の変更、呼び出しタイプの変更が含まれます。
新しいバージョンのオンライン公開は、API 呼び出しに影響します。プロジェクトでさまざまな公開制御メカニズムを構成できます。API が公開されると、システムは API が属するプロジェクトの構成に基づいて API をブロックまたは公開します。詳細については、「サービスプロジェクトを作成する」をご参照ください。
論理テーブルに基づいて作成された API は、一括公開をサポートしていません。
一括公開中にバージョンが選択されていない場合、API は公開されません。
編集
操作列の [編集] アイコンをクリックして、API 編集ページに移動します。
説明システムは、デフォルトで最新の API バージョンの編集ページに入ります。API の別のバージョンを修正するには、編集ページの右上隅で API バージョンを切り替えて、異なるバージョンを編集できます。
API バージョンが送信済みまたはドラフト状態の場合、ページの左上隅で API の表示に切り替えることができます。あいまい検索を使用して名前または ID で API を検索し、現在のサービスプロジェクトでアクセス権限を持つ API を切り替えることができます。システムは、現在のプロジェクトで最後にアクセスした 9 つの API (表示、編集、テスト、追加を含む) を推奨します。
API の最新バージョンが公開済みの状態の場合、編集はサポートされていません。システムは、最後に公開されたバージョンに基づいて新しいバージョンを自動的に作成し、バージョン番号を自動的に入力します。バージョンとバージョン番号が正しいことを確認したら、[OK] をクリックして API バージョン追加ページに移動します。
API バージョンが送信済みまたはドラフト状態の場合、API 編集ページに直接移動できます。
テスト
操作列の [テスト] アイコンをクリックして、[開発者] > [API] > [APIテスト] ページに移動します。システムは、テスト対象の現在の API の最新のテスト可能バージョン（送信済みまたは公開済みの状態のバージョン）を自動的に入力します。
説明テスト環境では、複数の API バージョンが共存してテストできます。さまざまな API 呼び出しのテスト結果に基づいて、フィードバックが良いバージョンをオンラインアプリケーションに公開できます。操作の詳細については、「手順 1: API をテストする」をご参照ください。
バージョン管理
操作列の [詳細] アイコンをクリックし、[バージョン管理] を選択します。[バージョン管理] パネルでは、API の異なるバージョンの編集、テスト、バージョン比較、削除、およびクローン作成を実行できます。
説明ダウンストリームアプリケーションが API を呼び出すときに API_ID を変更できず、API のデータソースまたはクエリ条件が変更された場合は、複数のバージョンを開発およびテストしてから、新しいバージョンを本番環境に公開して元のバージョンを上書きできます。これにより、ダウンストリームアプリケーション側の調整を回避できます。構成の詳細については、「API マルチバージョン管理」をご参照ください。
API プロパティ の変更
操作列の [詳細] アイコンをクリックし、[API プロパティの変更] を選択します。[API プロパティの変更] ダイアログボックスで、API 名、API グループを変更できます。名前の命名規則は、新しい API を作成する場合と同じです。
所有者の変更
操作列の [詳細] アイコンをクリックし、[所有者の変更] を選択します。[所有者の変更] ダイアログボックスで、[ユーザーアカウント] を選択します。プロジェクト内の別の開発者またはプロジェクト管理者に API を転送できます。[OK] をクリックして所有者を変更します。
API のクローン
操作列の [詳細] アイコンをクリックし、[API のクローン] を選択します。[API のクローン] ダイアログボックスで、クローン作成するバージョンを選択し、[OK] をクリックして、詳細情報を変更できる API の作成ページに移動します。
説明API のクローンを作成すると、API の選択したバージョンのすべての情報がクローンされ、新しい API が作成されます。プロジェクト内で API 名は一意である必要があるため、送信エラーを回避するために新しい API の名前を変更してください。
システムは、デフォルトで最後に送信された (公開済みを含む) バージョンを選択します。状態に関係なく、現在の API の任意のバージョンをクローンできます。
削除
操作列の [詳細] アイコンをクリックし、[削除] を選択します。API に依存関係がない場合は、[API 削除] ダイアログボックスで [OK] をクリックして削除します。API 権限がアプリケーションに付与されている場合、または API が複合 API によって参照されている場合は、API を削除する前に、アプリケーションに付与されている権限を取り消すか、複合 API から参照を削除する必要があります。
API マルチバージョン管理
API バージョンの追加
API リストページで、操作列の [バージョン管理] をクリックして、[バージョン管理] パネルに移動します。
[バージョン管理] パネルで、[バージョンの追加] をクリックしてパラメーターを構成します。
パラメーター
説明
既存のバージョンに基づく
デフォルトでは、最新バージョンが入力されます。状態に関係なく、現在の API の任意のバージョンを選択できます。
バージョン番号
システムはデフォルトでバージョン番号を入力します。これは変更できます。各 API には一意のバージョン番号があり、以前のバージョンとの比較が容易になります。バージョン番号は 64 文字に制限されており、API に対して一意である必要があります。
[OK] をクリックして、[API バージョンの追加] ページに移動し、パラメーターを構成します。
情報が正しいことを確認したら、[送信] をクリックして、新しい API バージョンの作成を完了します。API リストページで API を管理できます。
API バージョンの管理
領域 | 説明 |
①API 名 | 現在の API の名前を表示します。 |
②リスト領域 | バージョン番号、バージョンステータス、作成者、更新日時が表示されます。 |
③操作領域 | 状態が異なるバージョンでは、異なる操作がサポートされます。
操作は次のように説明されています。
|