[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 파일에 추가한 후에 Liberty REST 엔드포인트에서 Swagger 2.0 문서를 노출해야 합니다. Liberty 서버에서 REST API 문서 발견에 있는 프로시저의 1단계와 2단계를 완료하십시오.

프로시저

  1. http://controller_host:controller_http_port/api/collective/registry URL에서 브라우저를 지시하십시오.

    controller_hostcontroller_http_port를 집합체 제어기의 값으로 대체하십시오.

  2. 옵션: 공용 엔드포인트의 URL을 제어기 server.xml 파일의 publicURL 속성으로 변경하십시오.

    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