Busca de APIs

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

api search

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

  • Keywords: você pode pesquisar por palavras que estão 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 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 (que vem marcado como padrão) para retornar as APIs que são somente suas, do seu time ou organização da qual você faz parte. Caso você desmarque essa opção, irá visualizar todas as APIs do API Manager que você está acessando.

Busca detalhada

É possível fazer buscas detalhadas diretamente no campo Keywords inserindo queries de sintaxe Lucene. Para facilitar as buscas, incluímos também 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 será automaticamente gerada para a sua busca.

Para abrir essas opções, clique na seta ao lado do campo Keywords (como 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 é parte da sua URL.

  • Method: método HTTP que a API admite.

  • Creation Date: data de criação. O campo inclui uma qualificação da data (nessa ordem: "igual a", "anterior a", "posterior a" e "entre") e um campo para seleção da data (caso você tenha escolhido a opção "entre", existirão dois campos para data, o inicial e o final, compondo o período a ser considerado para a filtragem).

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

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

O item Attributes só se aplica a usuários que tenham o add-on Adaptive Governance ativo.

  • Environment Variable: campo para definir se a API possui/não possui (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 está (undeployed) implantada em um determinado ambiente. Mais de um ambiente pode ser selecionado.

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

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

  • API Type: tipo da API, entre REST, Identity e GraphQL.

Thanks for your feedback!
EDIT

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