Tutorial: Importando uma API

Editar online

Este tutorial mostra como importar uma definição existente do site OpenAPI 2.0.

Sobre este Tutorial

Este tutorial inclui as seguintes lições:
  1. Importando uma API
  2. Testando a API importada

Antes de Iniciar

Observação: o catálogo do Sandbox deve ser configurado para usar um DataPower® Gateway (v5 compatible) ou um DataPower API Gateway ou ambos. Consulte Criação e configuração de catálogos.

Se o catálogo do Sandbox usar um DataPower Gateway (v5 compatible), faça o download do arquivo findbranch_v6.txt para seu sistema de arquivos local. Renomeie esse arquivo para findbranch.yaml.

Importando uma API

Para importar uma API, conclua as etapas a seguir:
  1. Faça login na interface do usuário do API Manager.
  2. Na página inicial, clique no bloco Desenvolver APIs e produtos.

    Página inicial do API Manager

  3. Na página “Desenvolver”, clique em “Adicionar” > “API ”.

    Tela Adicionar API

  4. Selecione OpenAPI 2.0.
  5. Na seção Import, selecione Existing OpenAPI e clique em Next.

    Opção existente em OpenAPI

  6. Arraste e solte os arquivos aqui ou clique para fazer o upload.
    Clique na mensagem para carregar um arquivo
  7. Selecione o arquivo findbranch.yaml em seu sistema de arquivos local e faça o upload dele. Em seguida, clique em Next.

    O arquivo validado está pronto para ser importado

  8. A página Resumo é exibida.

    A nova API é criada. Deixe a página Summary aberta para a próxima etapa.

    Observação: A API não pode ser executada a menos que esteja ativa.

    Resumo da API importada

Testando a API importada

Para testar a API importada, conclua as etapas a seguir:
  1. Na página Summary (Resumo ), clique em Edit API (Editar API)
  2. Na página Develop / findbranch, clique na guia Test no cabeçalho da página.

    A API importada FindBranch já tem uma definição, que usa uma única política chamada Invoke para executar a API. Essa API está pronta para ser testada.

  3. Para ativar a API, clique em Target Configuration.

    FindBranch API

  4. Na janela Preferences (Preferências ), ative a opção Auto-publish (Publicação automática) para definir o status da API como on-line.

    Painel de teste

  5. Clique em Send (Enviar ).

    Invocação de teste

  6. Se for exibida a mensagem Nenhuma resposta recebida, clique em Abrir o servidor.

    Mensagem de ausência de resposta

    Uma nova guia do navegador é aberta. Se for exibida uma mensagem de erro, ignore-a. Feche a nova guia e retorne à guia Teste.

  7. Clique em Send novamente. Veja a resposta na seção Resposta.

    Resposta à chamada de API bem-sucedida

O Quê foi Feito Neste Tutorial

Neste tutorial, você concluiu as seguintes atividades:
  • Importou uma definição de API.
  • Testou uma API.