Busca de APIs

A tela API Catalog mostra todas as APIs disponíveis na sua API Platform.

A página contém uma ferramenta de busca simples e uma de busca detalhada. Os campos disponíveis para busca são:

  • Keywords: você pode pesquisar por palavras que estejam em qualquer campo da API, seja como parte do nome ou dentro de algum campo de descrição de recursos, por exemplo. O campo aceita buscas utilizando a sintaxe Lucene. Você também pode clicar na seta ao lado do campo para abrir a busca detalhada (veja mais sobre isso abaixo).

  • Order By: campos disponíveis para ordenação da busca.

  • Sort: ordenação crescente ou decrescente.

  • Show only my context APIs: checkbox (marcado por padrão) para retornar as APIs que são somente suas, do seu time ou da organização da qual você faz parte. Caso você desmarque essa opção, serão exibidas todas as APIs do API Manager que você está acessando.

Busca detalhada

É possível realizar buscas detalhadas diretamente no campo Keywords inserindo queries em sintaxe Lucene. Para facilitar as buscas, também incluímos campos específicos para filtrar as APIs. Quando você preenche um dos campos com a informação que deseja usar como base para a filtragem, uma query é gerada automaticamente para a busca.

Para abrir essas opções, clique na seta ao lado do campo Keywords (como mostrado na imagem abaixo).

detailed search

Você pode preencher quantos campos quiser ao mesmo tempo, filtrando as APIs por uma ou múltiplas variáveis. Os campos que podem ser utilizados para a filtragem são:

  • API Name: nome da API.

  • API Version: versão da API.

  • Path: o caminho da API, que faz parte da sua URL.

  • Method: método HTTP suportado pela API.

  • Creation Date: data de criação. O campo inclui uma qualificação da data (nesta ordem: "igual a", "anterior a", "posterior a" e "entre") e um campo para seleção da data. Caso você escolha a opção "entre", serão exibidos dois campos de data (inicial e final), que definem o período considerado para a filtragem.

  • Interceptors: campo para definir se a API possui ou não (has/doesn’t have) um determinado interceptor. Mais de um interceptor pode ser selecionado.

  • Attributes: campo para definir se a API possui ou não (has/doesn’t have) um determinado atributo. Mais de um atributo pode ser selecionado clicando em +.

O item Attributes está disponível apenas para usuários que tenham o add-on Adaptive Governance ativo.

  • Environment Variable: campo para definir se a API possui ou não (has/doesn’t have) uma determinada variável de ambiente, que deve ser informada.

  • Description: descrição da API.

  • Environment: campo para definir se a API está (deployed) ou não (undeployed) implantada em um determinado ambiente. Mais de um ambiente pode ser selecionado.

  • API Responsible: campo para digitar o usuário responsável pela API.

    • Aqui você deve incluir o nome do usuário, não o email.

  • API Type: tipo da API: REST, Identity ou GraphQL.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]