Pesquisar e filtrar APIs

Esta página se aplica à Apigee e à Apigee híbrida.

Este tópico descreve como usar a Pesquisa inteligente com a tecnologia Vertex AI e opções de pesquisa baseadas em filtros para pesquisar recursos específicos no hub da API.

É fácil encontrar e acessar os recursos da API registrados no hub de API usando a pesquisa inteligente. A pesquisa inteligente permite que você pesquise todos os recursos de API disponíveis na sua instância usando uma consulta de pesquisa de texto livre. É possível pesquisar em todos os tipos de entidade (APIs, operações de API, especificações etc.) ou especifique o tipo de entidade que você quer consultar.

Com o mecanismo de pesquisa da Vertex AI, a Pesquisa inteligente pode ir além do termo "correspondência". A pesquisa inteligente retorna resultados contendo termos encontrados em qualquer lugar nas entradas detalhadas do recurso da API que são semanticamente semelhantes às consultas de pesquisa de texto livre inseridas.

A pesquisa de texto livre retorna uma lista paginada de resultados da pesquisa que inclui os seguintes detalhes:

  • Nome do recurso: o nome da API, da operação da API ou do arquivo de especificação.
  • Descrição do recurso: uma breve descrição do recurso.
  • Proprietário do recurso: o nome e o endereço de e-mail do proprietário do recurso.
  • Link de detalhes do recurso: um link para a página de informações detalhadas do recurso.

Para pesquisar APIs que contêm um termo específico:

  1. No console do Google Cloud, acesse a página Hub de API Discover.

    Acessar o hub de API Discover

  2. Digite uma consulta de pesquisa na caixa de pesquisa.

    Por exemplo, você pode inserir "APIs de gerenciamento de pedidos" ou "Arquivo de especificações para as configurações da operadora sem fio".

    Você pode refinar sua pesquisa usando atributos do sistema no prompt da consulta de pesquisa. Se você criou atributos de usuário ao registrar suas APIs no hub de API, também será possível incorporar esses atributos nos prompts de consulta de pesquisa.

  3. A lista de Resultados da pesquisa exibirá uma lista de recursos de API que contêm termos semanticamente semelhantes à consulta de pesquisa inserida.
  4. Clique no nome do recurso de API para acessar a página de detalhes dele.
  5. Para limpar a consulta atual, clique em Limpar resultados.

Também é possível pesquisar os recursos do hub da API usando a API Hub. O método searchResources permite consultar os recursos do hub da API usando consultas e filtros de texto livre.

É possível usar a seguinte chamada de API para pesquisar nos recursos do hub de API: 

curl -X POST https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"QUERY",
    "filter":"resource_type = RESOURCE_TYPE"
   }'

Em que:

  • PROJECT_ID é o ID do projeto host da instância do hub da API.
  • LOCATION é o local onde a instância do hub da API está hospedada.
  • QUERY é a consulta de texto livre a ser usada na pesquisa. A consulta pode conter palavras-chave relacionadas a qualquer detalhe do recurso do hub da API, incluindo nomes de exibição, descrições ou outros metadados.
  • RESOURCE_TYPE é o filtro opcional especificado para sua pesquisa. É possível especificar um dos seguintes tipos de recurso do hub de API como filtro:
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

Por exemplo: 

curl -X POST https://apihub.googleapis.com/v1/projects/{project-id}/locations/{location}:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"dog status in the store",
    "filter":"resource_type = SPEC"
    }'

Essa chamada retorna uma lista paginada de recursos do hub da API, incluindo o seguinte:

  • O nome de exibição do recurso.
  • Uma descrição do recurso.
  • Um link para a documentação sobre os recursos.
  • O proprietário do recurso.

Se outros atributos do sistema ou do usuário estiverem configurados para o recurso, os metadados associados a eles também serão retornados.

Para mais informações sobre a pesquisa de texto livre com a API Hub da API, consulte a documentação de referência da API para Method:project.locations.searchResources.

Opções de pesquisa baseadas em filtros

Você pode refinar a lista de APIs exibida na página APIs usando atributos do sistema como parâmetros de pesquisa. Se você criou atributos definidos pelo usuário ao registrar as APIs no hub da API, também é possível incorporar esses atributos nas consultas de pesquisa. Personalize a lista de recursos da API exibida usando uma das seguintes opções:

Filtro

Usando a pesquisa de lista baseada em filtros, é possível otimizar a lista de APIs com base em vários parâmetros predefinidos e atributos do sistema associados ao recurso. Você pode usar as opções Match ALL ou Match ANY para personalizar a visualização com filtro.

Para especificar as opções de filtro, faça o seguinte:

  1. No console do Google Cloud, acesse a página de APIs do hub das APIs.

    Acessar APIs do hub das APIs

  2. Clique no campo Filtrar tabela para filtrar a tabela. O painel Filtro será aberto.
  3. Especifique ou selecione as opções de filtro:
    • Nome da API: o nome de exibição da API
    • Documentação: um link curto para a documentação da API.
  4. Após selecionar uma opção de filtro, selecione um valor na lista Valores. Como alternativa, você pode inserir um valor para o atributo de filtro selecionado.
  5. Para adicionar mais um filtro, clique no campo Filtrar tabela para selecionar um dos Operadores disponíveis e selecione outro atributo e valor de filtro.

  6. As propriedades de filtro selecionadas exibem a lógica condicional que a consulta de filtro está usando. Você pode selecionar OR como operador. Se nenhum operador for selecionado, o padrão será AND.

  7. Para limpar um filtro individual, clique no X no filtro. Para limpar todos os filtros, clique em Limpar tudo no painel Filtro.

Ordenar

Para reordenar a lista de APIs exibida:

  1. No console do Google Cloud, acesse a página de APIs do hub das APIs.

    Acessar APIs do hub das APIs

    A página da lista APIs é exibida por padrão.

  2. Na página da lista APIs, localize o cabeçalho da coluna API name.
  3. A seta indica a prioridade de classificação atual. Uma seta para baixo indica ordem decrescente. Uma seta para cima indica ordem crescente.
  4. Clique em Nome da API para ordenar a lista de APIs por nome.

Paginação

Quando há vários recursos de API, eles podem aparecer em diversas páginas.

Para personalizar a exibição da lista e navegar entre as páginas:

  1. No console do Google Cloud, acesse a página de APIs do hub das APIs.

    Acessar APIs do hub das APIs

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, localize as ferramentas de paginação, conforme mostrado abaixo:

  3. Selecione o número de APIs a serem exibidas por página.
  4. Clique em > Avançar para ir para a próxima página.
  5. Clique em < Voltar para voltar à página anterior.

A seguir