Testando uma API com a guia Explorer

Editar online

Use a guia “Explorer” no editor de API para ver como suas APIs aparecem para um usuário no Catálogo de Consumidores. Também é possível usar a ferramenta Testar para testar o comportamento da API.

Antes de Iniciar

Para testar uma API na ferramenta de teste Experimente a API deve ser publicada automaticamente. Se a API não for publicada automaticamente, a ferramenta Try it não será ativada no Explorer..

É possível concluir essa tarefa usando o aplicativo da UI do API Designer ou usando a UI do API Manager baseado em navegador.

Sobre essa tarefa

A guia “Explorer” no editor de API das interfaces do API Designer e do API Manager permite que você visualize como suas APIs aparecem para um consumidor de API no Catálogo de Consumidores. Você pode consultar as descrições dos diferentes artefatos, bem como quaisquer esquemas ou exemplos, e também pode testar o comportamento da API usando a ferramenta “Experimente ”.

Nota:
  • Não é possível usar a ferramenta Experimente para testar APIs não impostas.

Procedimento

Para testar uma API usando a ferramenta Experimente , conclua as etapas a seguir:
  1. Se você estiver usando o API Designer, defina o modo como “Online” no menu Menu de opções “Opções” da página principal.
  2. No painel de navegação, clique em Desenvolver ícone na área de janela de navegação da UI da API Desenvolver e, em seguida, selecione a guia APIs.
  3. Clique no título da API com a qual deseja trabalhar.
    O editor de API é exibido
  4. Clique na guia Explorer .
    Uma Visão geral da API é exibida
  5. Clique nos artefatos de API na barra de menus lateral para explorar as operações e definições que estão disponíveis na API, incluindo a revisão de quaisquer exemplos e esquemas.
  6. Para testar o comportamento da API, clique em uma operação na barra de menus lateral e clique na guia Experimentar .
    É exibido o painel de teste da operação, conforme mostrado no exemplo a seguir:
    A área de janela de teste Experimente na guia Explorer..
  7. Forneça todos os parâmetros de API necessários e clique em Enviar.
    A resposta da API é exibida na seção Resposta.
    Observação: Se você receber uma mensagem relacionada a um certificado não confiável, clique no link fornecido, aceite o certificado e, em seguida, volte ao ambiente de teste e clique em Enviar novamente.

O quê fazer em seguida

Quando você estiver satisfeito com a aparência e o comportamento de sua API, será possível preparar a API para um Produto em um Catálogo. Para obter mais informações, consulte Preparando uma API..