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 環境にエディターをインストールすると、メニュー・オプションを使用して 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 はサービスに関連付けられている必要があります。File Manager API の場合、この目的のために fmService.sar、fmIMSService.sar、および fmDB2Service.sar という名前のサービス・アーカイブ・ファイルが提供されます。サービス・アーカイブ・ファイルは、File Manager Service Provider for z/OS Connect のインストール時に Eclipse 環境からアクセス可能な場所にコピーされます (「File Manager Customization Guide」を参照)。
あるいは、提供されている File Manager ビルド・ツールキット・プラグインを使用して、独自のサービス・アーカイブ (SAR ファイル) を作成することもできます。
API 作成時は、API を File Manager サービスと関連付ける必要があります。「Service」ボタンをクリックし、ファイル・システム上の File Manager サービス・アーカイブ・ファイルにナビゲートします。
API 呼び出し元によって提供されたデータを、File Manager サービス・プロバイダーが必要とする JSON 要求スキーマにマップできます。
一般的な要求の例: 要求スキーマの API データのマッピング では、ファイル名およびテンプレート名のパス・パラメーター、およびタイムアウトの照会パラメーターが要求スキーマにマップされています。API 作成者は、必要なだけ要求スキーマをマップできます。何もマップしない場合でも、REST API 呼び出しを実行するクライアントは HTTP 要求本文で指定する必要があります。
新しいAPIは、メニュー・オプションを使用して、z/OS Connect WebSphere Liberty Profile (WLP) 環境にデプロイできます。