Partilhar via


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

APLICA-SE A: Todas as camadas de gerenciamento de API

Para melhorar o desenvolvimento das suas APIs, pode exportar uma API gerida no API Management para o Postman. Exporte uma definição de API do Gerenciamento de API como uma coleção do Postman para que você possa usar as ferramentas do Postman para projetar, documentar, testar, monitorar e colaborar em APIs.

Nota

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

Pré-requisitos

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

  • Certifique-se de que sua instância gerencie uma API que você gostaria de exportar para o Postman.

    Nota

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

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

Vá para a sua instância de Gestão de API

  1. No portal Azure, pesquise e selecione serviços de Gestão de API:

    Captura de tela que mostra os serviços de Gerenciamento de API nos resultados da pesquisa.

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

    Captura de tela que mostra uma instância de Gerenciamento de API na página Serviços de 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 exportar. Pode selecionar a opção para a aplicação de ambiente de trabalho se a tiver instalado localmente.

  4. No Postman, selecione um espaço de trabalho do Postman para o qual importar a API. O padrão é Meu espaço de trabalho.

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

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

    Captura de ecrã da coleção importada no Postman.

Desenvolvimento de API com API Management e Postman

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

As APIs desenvolvidas no Postman podem ser exportadas e importadas de volta para o Gerenciamento de API como revisões de API. Isso permite que você desenvolva APIs no Postman e, em seguida, implante-as no Gerenciamento de API para acesso e gerenciamento de tempo de execução. Para mais informações, consulte Deploy to Azure API Management a partir do Postman API Builder.

Atenção

Tenha cuidado ao passar chaves de assinatura do Gerenciamento de API ou outros dados confidenciais no Postman. Recomenda-se usar o Postman Vault para armazenar dados confidenciais como segredos na sua instância do Postman, para que possa reutilizar segredos com segurança nas suas coleções e solicitações.