[17.0.0.1 and later]

集合内のすべてのパブリック RESTful API のリスト

集合サービス照会を使用して、集合全体におけるすべてのパブリック RESTful API (サービス) に関する API 文書をディスカバーします。この照会では、文書がリスト形式で示されます。

リストには、各サービスの要約 (名前、バージョン、説明など) と、当該サービスを現在デプロイしているホストのリストが含まれます。このリストはリアルタイムで更新され、集合メンバーでサービスが追加または削除されると変更されます。集合メンバーが Liberty、Docker と Liberty、LoopBack®、または Docker と LoopBack の各サーバーのいずれであるかに関係なく、このリストには、すべての集合メンバーからのサービスが含まれます。

集合サービス照会のデフォルト URL は、http://controller_host:controller_http_port/api/collective/registry です。

始める前に

/api/collective/registry API は、Liberty API ディスカバリー・フィーチャーに含まれています。集合内のパブリック・サービスを照会するには、まず、apiDiscovery-1.0 フィーチャーを集合コントローラーの server.xml ファイルに追加してから、Swagger 2.0 文書を Liberty REST エンドポイントで公開する必要があります。 Liberty サーバー上の REST API 資料のディスカバーの手順のステップ 1 および 2 を実行します。

手順

  1. ブラウザーで http://controller_host:controller_http_port/api/collective/registry URL を指定します。

    controller_host および controller_http_port は、集合コントローラーの値に置き換えてください。

  2. オプション: コントローラーの server.xml ファイル内の publicURL 属性で、パブリック・エンドポイントの URL を変更します。

    server.xml ファイル内の apiDiscovery エレメントの publicURL 属性を使用して、http://controller_host:controller_http_port/api/collective/registry URL の api 部分を構成できます。

    例えば、以下のように publicURL 属性を使用して、集合の RESTful サービス・レジストリーの場所を /api/collective/registry から /services/collective/registry に変更できます。

    1. <apiDiscovery publicURL="/services"/> をコントローラーの server.xml ファイルに追加します。
    2. ブラウザーで http://controller_host:controller_http_port/services/collective/registry URL を指定します。

    publicURL 属性について詳しくは、『Liberty サーバー上の REST API 資料のディスカバー』を参照してください。

タスクの結果

この照会により、以下のようなパブリック・サービスのリストが示されます。

{  
   "services":[
      {  
         "service":"/airlines/booking",
         "title":"Booking REST APIs",
         "description":"A microservice exposing booking APIs for various airlines.",
         "version":"1.0.0",
         "hosts":[  
            "vm001:9081",
            "vm002:9082"
         ]
      },
      {  
         "service":"/flight/status",
         "title":"Flight Status REST APIs",
         "description":"A microservice exposing flight status APIs for various airports.",
         "version":"1.0.1",
         "hosts":[  
            "vm003:9085"
         ]
      },
      {  
         "service":"/tourism",
         "title":"Tourism REST APIs",
         "description":"A microservice exposing tourism information for various popular destinations.",
         "version":"2.0.0",
         "hosts":[  
            "vm004:9443"
         ]
      }
   ]
}

トピックのタイプを示すアイコン タスク・トピック

ファイル名: twlp_api_discovery_list_query.html