z/OS® Connect API の作成

z/OS® Connect EE API Editor をご使用の Eclipse 環境にインストールすると、z/OS® Connect EE API Project を作成できるパースペクティブが追加されます。

z/OS® Connect EE API Editor は、REST API を作成するために IBM® Explorer for z/OS® にインストールする Eclipse ベースのワークステーション・ツールです。ご使用の Eclipse 環境にエディターをインストールすると、File > Newメニュー・オプションを使用して z/OS® Connect EE API Project を作成できる新しいパースペクティブが使用可能になります。

このエディターは、IBM® Mainframe Developer Center からダウンロードできます。z/OS Connect および z/OS Connect EE API エディターの資料については、IBM® Knowledge Center で提供されています。

API エディターを使用すると、API に対してパス・パラメーターや照会ストリングを含む URL を定義することができます。例:

パス・パラメーターと照会ストリングを使用した API エディターでの URL の定義 — 図 1. z/OS Connect EE API Editor

各 API はサービスに関連付けられている必要があります。Z Data Tools API の場合、この目的のために zdtService.sar、zdtIMSService.sar、および zdtDB2Service.sar という名前のサービス・アーカイブ・ファイルが提供されます。サービス・アーカイブ・ファイルは、Z Data Tools Service Provider for z/OS Connect のインストール時に Eclipse 環境からアクセス可能な場所にコピーされます (「Z Data Tools Customization Guide」を参照)。

あるいは、提供されている Z Data Tools ビルド・ツールキット・プラグインを使用して、独自のサービス・アーカイブ (SAR ファイル) を作成することもできます。

API 作成時は、API を Z Data Tools サービスと関連付ける必要があります。「Service」ボタンをクリックし、ファイル・システム上の Z Data Tools サービス・アーカイブ・ファイルにナビゲートします。

新しい API とサービス・アーカイブ・ファイルの関連付け — 図 2. API と Z Data Tools サービスの関連付け

API 呼び出し元によって提供されたデータを、Z Data Tools サービス・プロバイダーが必要とする JSON 要求スキーマにマップできます。

一般的な要求の例: API 呼び出しから要求スキーマへのデータのマッピング — 図 3. 一般的な要求の例: 要求スキーマの API データのマッピング

一般的な要求の例: 要求スキーマの API データのマッピングでは、ファイル名およびテンプレート名のパス・パラメーター、およびタイムアウトの照会パラメーターが要求スキーマにマップされています。API 作成者は、必要なだけ要求スキーマをマップできます。何もマップしない場合でも、REST API 呼び出しを実行するクライアントは HTTP 要求本文で指定する必要があります。

新しいAPIは、z/OS Connect EE > Deploy API to z/OS Connect EE Serverメニュー・オプションを使用して、z/OS Connect WebSphere Liberty Profile (WLP) 環境にデプロイできます。