Al gestionar aplicaciones de microservices, con frecuencia es necesario comprender las interfaces API que expone cada servicio (métodos, parámetros, rutas y tipos de retorno) sin revisar el código fuente. Los contratos de servicio describen las API de sus microservices con base en la especificación OpenAPI. Los sistemas de microservices operan y se ejecutan a partir de estos contratos. Una vez que despliega una aplicación en Microservices Engine (MSE), puede inspeccionar los detalles de su API directamente en la consola de MSE, sin dependencias adicionales en la aplicación.
Los contratos de servicio también constituyen la base de la función de prueba de servicios, que permite invocar cualquier API directamente desde la consola.
Funciones
Los contratos de servicio ofrecen las tres funciones siguientes:
|
Función |
Descripción |
|
Consulta de API |
Consulte los detalles de la API de cualquier proveedor o consumidor de servicios, incluidos nombres de métodos, listas de parámetros y tipos de retorno. Para servicios de Spring Cloud, también están disponibles los métodos de solicitud, las rutas de solicitud y los nombres de clase. |
|
Análisis sintáctico de anotaciones Swagger |
Swagger es el principal contribuyente a la especificación OpenAPI y una herramienta estándar básica para describir API. Si su código utiliza anotaciones de Swagger u OpenAPI, los valores analizados aparecen en la columna Description de la página del contrato. Swagger 2.0: |
|
Prueba de servicios |
Pruebe cualquier método o ruta de API directamente desde la consola mediante la información de parámetros y métodos recopilada a través del contrato de servicio. |
Consultar un contrato de servicio
Inicie sesión en la consola de MSE y seleccione una región en la barra de navegación superior.
En el panel de navegación izquierdo, vaya a Microservices Governance > Service query.
-
En la página Service query, localice el servicio objetivo y haga clic en su nombre.
Para ubicar un servicio específico, utilice los campos de búsqueda en la parte superior de la página. Puede efectuar una búsqueda aproximada según las dimensiones siguientes:
Filtro
Caso de uso
Service name
Búsqueda por nombre completo o parcial del servicio
IP address
Búsqueda por dirección IP de una instancia de servicio
Application name
Búsqueda por nombre de la aplicación desplegada
-
En el panel Service details, revise la información del contrato. El panel contiene las secciones siguientes:
Sección
Información mostrada
Basic Information
Metadatos generales del servicio
service provider
Detalles de la interfaz del lado del proveedor
service consumer
Detalles de la interfaz del lado del consumidor
Interface metadata
Metadatos asociados a la interfaz del servicio
Metadata Metadata
Metadatos adicionales sobre el servicio
Si su servicio utiliza anotaciones de Swagger, los valores analizados de dichas anotaciones aparecen en las columnas Method Name/Description y Parameters/Description.