Ao gerenciar aplicações de microsserviços, é comum precisar compreender as interfaces de API expostas por cada serviço — métodos, parâmetros, caminhos e tipos de retorno — sem analisar o código source. Os contratos de serviço descrevem as APIs de microsserviços com base na especificação OpenAPI. Sistemas de microsserviços operam e executam com base nesses contratos. Após implantar uma aplicação no Microservices Engine (MSE), visualize os detalhes da API diretamente no console do MSE, sem necessidade de dependências adicionais na aplicação.
Os contratos de serviço também servem como base para o recurso de teste de serviço, que permite invocar qualquer API diretamente do console.
Capacidades
Os contratos de serviço oferecem as três capacidades a seguir:
|
Capacidade |
Descrição |
|
Consulta de API |
Visualize detalhes da API de qualquer provedor ou consumidor de serviço, incluindo nomes de métodos, listas de parâmetros e tipos de retorno. Para serviços Spring Cloud, métodos de solicitação, caminhos de solicitação e nomes de classes também estão disponíveis. |
|
Análise de anotações Swagger |
O Swagger é o principal contribuidor da especificação OpenAPI e uma ferramenta padrão básica para descrever APIs. Caso seu código utilize anotações Swagger ou OpenAPI, os valores analisados aparecem na coluna Description da página de contrato. Swagger 2.0: |
|
Teste de serviço |
Teste qualquer método ou caminho de API diretamente do console, utilizando as informações de parâmetros e métodos coletadas por meio do contrato de serviço. |
Visualizar um contrato de serviço
Faça login no console do MSE e selecione uma região na barra de navegação superior.
No painel de navegação à esquerda, escolha Microservices Governance > Service query.
-
Na página Service query, localize o serviço desejado e clique em seu nome.
Para encontrar um serviço específico, utilize os campos de pesquisa na parte superior da página. É possível realizar uma busca aproximada pelas seguintes dimensões:
Filtro
Caso de uso
Service name
Pesquise pelo nome completo ou parcial do serviço
IP address
Pesquise pelo endereço IP de uma instância de serviço
Application name
Pesquise pelo nome da aplicação implantada
-
No painel Service details, revise as informações do contrato. O painel contém as seguintes seções:
Seção
Informações exibidas
Basic Information
Metadados gerais sobre o serviço
service provider
Detalhes da interface do lado do provedor
service consumer
Detalhes da interface do lado do consumidor
Interface metadata
Metadados associados à interface de serviço
Metadata Metadata
Metadados adicionais sobre o serviço
Se o serviço utilizar anotações Swagger, os valores analisados aparecerão nas colunas Method Name/Description e Parameters/Description.