IBM API Connect に API をプッシュするための REST エンドポイント
REST エンドポイントは、オンプレミスとクラウドの両方の Liberty ユーザーにとってのセントラル・ロケーションであり、API の視覚化、呼び出し、および IBM® API Connect へのプッシュに使用することができます。
IBM API Connect へのデプロイ済み REST エンドポイントのプッシュ
デプロイ済みの REST エンドポイントを IBM API Connect にプッシュするには、新規の REST エンドポイント /ibm/api/docs/apiconnect を呼び出す必要があります。このエンドポイントは、サーバー構成内の apiDiscovery-1.0 フィーチャーによって公開されます。管理者および開発者は、REST エンドポイントを使用して、IBM API Connect フレームワーク・カタログを検索する社内開発者に Liberty インスタンスのアセットを公開することができます。
製品定義の提供
すべての API は、製品によって参照され、カタログで公開されます。したがって、呼び出し元は、Liberty が RESTful API を参照して、結果の製品を IBM API Connect にプッシュするために使用する製品定義を提供します。このトピックに、製品例を示します。
IBM API Connect への Liberty 集合のアセットの公開
対応する Liberty 集合エンドポイント /ibm/api/collective/docs/apiconnect を使用して、単一の RESTful トリガーを使用する IBM API Connect に Liberty 集合のすべてのアセットを公開することができます。Liberty 集合エンドポイントを使用すると、API Connect に接続されたクラウド開発者に何千もの API を公開できます。このエンドポイントの詳細な Swagger 定義については、Liberty RESTful API レジストリー /ibm/api/explorer を参照してください。
エンドポイントの要約
HTTP 要求メソッド: POST
URL: https://server:https_port/ibm/api/docs/apiconnect
必須ヘッダー
- X-APIM-Authorization
- API Connect に接続するための資格情報は、以下の 2 つの形式で表示されます。
- username および password
- xyz。ここで、xyz は username: password の base64 エンコード・バージョンです。
必須照会パラメーター
- サーバー
- https:// で始まる IBM API Connect サーバーの名前。
- カタログ
- 結果の製品をホストするカタログ名。
- 組織
- 呼び出し元の組織名。
オプションの照会パラメーター
- apiRoot
- マルチカーディナリティー・パラメーター。呼び出し元が API Connect にプッシュするコンテキスト・ルート (apiRoot=/myApp など) を正確に指定します。デフォルトでは、Liberty には、デプロイ済みのアプリケーションがすべて含まれます。ただし、既知の Liberty ランタイム Web アプリケーション・バンドルを除きます。このパラメーターは、公開するアプリケーションをフィルタリングする場合に役立ちます。
- メンバー ID (集合バリアントでのみ使用可能)
- マルチカーディナリティー・パラメーター。呼び出し元が公開しようとするアセットが含まれている集合メンバーそのものの ID を指定します。この ID は、ホスト名、URL エンコードされたユーザー・ディレクトリー、サーバー名という文字列で構成され、これらの文字列はすべてコンマで区切られます。例えば、myHost.com, %2Ftmp%2Fwlp%2Fusr, server1 のようになります。
- 入力の本文
- YAML または JSON コードのいずれかの製品定義。以下の YAML の例を参照してください。
product: "1.0.0" info: name: "pushed-product" title: "A Product that encapsulates Liberty APIs" version: "1.0.0" visibility: view: enabled: true type: "public" tags: - "string" orgs: - "string" subscribe: enabled: true type: "authenticated" tags: - "string" orgs: - "string" apis: liberty: name: "liberty-api:1.0.0" x-ibm-configuration: phase: "realized" testable: true enforced: true cors: enabled: true assembly: execute: - invoke: target-url: "${gateway.target}" title: "Invocation" description: "Invoking back-end service" plans: default: title: "Default Plan" rate-limit: hard-limit: false value: "100/hour" approval: false createdAt: "2016-04-18T20:33:22.937Z" createdBy: "string"