[17.0.0.1 and later]

Listado de todas las API RESTful publicas en un colectivo

Utilice una consulta de servicios de colectivo para descubrir documentación de API sobre todas las API RESTful públicas (servicios) en todo el colectivo. La consulta proporciona la documentación en formato de lista.

La lista contiene un resumen de cada servicio, por ejemplo, su nombre, versión y descripción, así como una lista de los hosts que despliegan actualmente este servicio. Esta lista se actualiza en tiempo real, cambiando a medida que los servicios se añaden o se eliminan en los miembros de colectivo. Esta lista contiene servicios de cualquier miembro de colectivo, independientemente de si los miembros son servidores Liberty, Docker y Liberty, LoopBack, o Docker y LoopBack.

El URL predeterminado de la consulta de servicios de colectivo es http://host_controlador:puerto_http_controlador/api/collective/registry.

Antes de empezar

La API /api/collective/registry está en la característica de descubrimiento de la API REST de Liberty. Para consultar los servicios públicos en un colectivo, primero debe añadir la característica apiDiscovery-1.0 a un archivo server.xml de controlador colectivo y a continuación exponer la documentación de Swagger 2.0 en puntos finales REST de Liberty. Complete los pasos 1 y 2 del procedimiento en Descubrimiento de la documentación de la API REST en un servidor Liberty.

Procedimiento

  1. Apunte un navegador al URL http://host_controlador:puerto_http_controlador/api/collective/registry.

    Sustituya controller_host y controller_http_port con los valores para el controlador colectivo.

  2. Opcional: Cambie el URL de los puntos finales públicos con el atributo publicURL del archivo server.xml del controlador.

    Puede configurar la parte api del URL http://host_controlador:puerto_http_controlador/api/collective/registry con el atributo publicURL en el elemento apiDiscovery del archivo server.xml.

    Por ejemplo, puede utilizar el atributo publicURL para cambiar la ubicación de su registro de servicio de colectivo de /api/collective/registry a /services/collective/registry:

    1. Añada <apiDiscovery publicURL="/services"/> al archivo server.xml del controlador.
    2. Apunte un navegador al URL http://host_controlador:puerto_http_controlador/services/collective/registry.

    Si desea más información sobre el atributo publicURL, consulte Descubrimiento de la documentación de la API REST en un servidor Liberty.

Resultados

La consulta proporciona una lista de servicios públicos:

{  
   "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":"API REST de turismo",
         "description":"Un microservicio que expone información de turismo para distintos destinos populares.",
         "version":"2.0.0",
         "hosts":[  
            "vm004:9443"
         ]
      }
   ]
}

Icono que indica el tipo de tema Tema de tarea

Nombre de archivo: twlp_api_discovery_list_query.html