Exportar definição de API para a Postman para teste, monitoramento e desenvolvimento de API

APLICA-SE A: todas as camadas do Gerenciamento de API

Para aprimorar o desenvolvimento das APIs, você pode exportar uma API de front-end no Gerenciamento de API para o Postman. Exporte uma definição de API a partir do Gerenciamento de API como coleção do Postman para que você possa usar as ferramentas do Postman para criar, documentar, testar, monitorar e colaborar em APIs.

Observação

Somente a definição de API pode ser exportada diretamente do Gerenciamento de API para a Postman. Outras informações, como políticas ou chaves de assinatura, não são exportadas.

Pré-requisitos

• Conclua o seguinte guia de início rápido: Criar uma instância do Gerenciamento de API do Azure.

• Verifique se a instância gerencia uma API que você gostaria de exportar para o Postman.

  Observação

  No momento, você só pode exportar APIs HTTP do Gerenciamento de API diretamente para o Postman.

• Uma conta do Postman, que você pode usar para acessar o Postman para Web.

  • Opcionalmente, baixe e instale o aplicativo de área de trabalho do Postman localmente.

Navegar até a instância de Gerenciamento de API

1. No portal do Azure, pesquise e selecione Serviços de Gerenciamento de API:

   

2. Na página Serviços do Gerenciamento de API, selecione sua instância do Gerenciamento de API:

   

Exportar uma API para o Postman

1. No portal, em APIs, selecione uma API.

2. No menu de contexto (...), selecione Exportar>Postman.

3. Na caixa de diálogo Executar em, selecione o local do Postman para o qual você deseja exportar. Você pode selecionar a opção para o aplicativo de área de trabalho, se tiver instalado localmente.

4. No Postman, selecione um workspace do Postman para o qual você deseja importar a API. O padrão é Meu Workspace.

5. No Postman, selecione Gerar coleção dessa API, para gerar automaticamente uma coleção da definição de API. Se necessário, configure as opções avançadas de importação ou aceite os valores padrão. Selecione Importar.

   A coleção e a documentação serão importadas para o Postman.

   

Desenvolvimento de API com Gerenciamento de API e Postman

Os desenvolvedores de API podem iterar rapidamente em alterações de API usando os recursos de teste, monitoramento e desenvolvimento da API da Postman.

As APIs desenvolvidas na Postman podem ser exportadas e importadas de volta para o Gerenciamento de API como revisões de API. Isso permite que você desenvolva APIs na Postman e, em seguida, implante-as no Gerenciamento de API para acesso e gerenciamento de runtime. Saiba mais

Atenção

Tenha cuidado ao passar chaves de assinatura do Gerenciamento de API ou outros dados confidenciais na Postman. O Cofre da Postman é recomendável para armazenar dados confidenciais como segredos de cofre em sua instância da Postman, para que você possa reutilizar segredos com segurança em suas coleções e solicitações.

Conteúdo relacionado

• Blog: Experiência aprimorada do desenvolvedor de API com a parceria entre a Microsoft e a Postman
• Saiba mais sobre como importar definições de API para a Postman.
• Saiba mais sobre como autorizar solicitações no Postman.