Compartilhar via

Importar uma API SOAP para o Gerenciamento de API e convertê-la em REST

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

Este artigo mostra como importar uma API SOAP como uma especificação WSDL e convertê-la em uma API REST. Ele também mostra como testar a API no Gerenciamento de API do Azure.

Neste artigo, você aprenderá como:

  • Importar uma API SOAP e convertê-la em REST
  • Testar a API no Portal do Azure

Observação

A importação do WSDL para Gerenciamento de API está sujeita a determinadas limitações. Arquivos WSDL com diretivas wsdl:import, xsd:import e xsd:include não são compatíveis. Para uma ferramenta de código aberto resolver e mesclar essas dependências em um arquivo WSDL, consulte este repositório GitHub.

Pré-requisitos

Navegar até a instância de Gerenciamento de API

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

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

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

    Captura de tela que mostra uma instância de Gerenciamento de API na página de serviços do Gerenciamento de API.

Importar e publicar uma API de back-end

  1. No painel esquerdo, na seção APIs , selecione APIs.

  2. Na página APIs, selecione + Adicionar API.

  3. Em Criar a partir da definição, selecione WSDL:

    Captura de tela que mostra o bloco do WSDL no portal do Azure.

  4. Na especificação WSDL, insira a URL para sua API SOAP ou clique em Selecionar um arquivo para selecionar um arquivo WSDL local.

  5. No Método de Importação, selecione SOAP para REST. Quando essa opção é selecionada, o Gerenciamento de API tenta fazer uma transformação automática entre XML e JSON. Nesse caso, os consumidores devem chamar a API como uma API RESTful, que retorna JSON. O Gerenciamento de API converte cada solicitação em uma chamada SOAP.

    Captura de tela que mostra a opção SOAP to REST.

  6. As caixas Nome de Exibição e Nome são preenchidas automaticamente com informações da API SOAP.

    As informações de nome de exibição, URL e Descrição são inseridas automaticamente para operações. As operações também recebem um Nome gerado pelo sistema.

  7. Insira outras configurações de API e selecione Criar. Você também pode configurar esses valores posteriormente acessando a guia Configurações .

    Para obter mais informações sobre configurações de API, consulte Importar e publicar sua primeira API.

Testar a nova API no portal do Azure

Você pode chamar as operações diretamente do portal do Azure. Esse método fornece uma maneira conveniente de exibir e testar as operações de uma API.

  1. Selecione a API que você criou na etapa anterior.

  2. Selecione a guia Testar.

  3. Selecione uma operação.

    A página mostra os campos dos parâmetros de consulta e os campos dos cabeçalhos. Um dos cabeçalhos é Ocp-Apim-Subscription-Key. Esse cabeçalho é para a chave de assinatura do produto associado a essa API. Se você criou a instância do Gerenciamento de API, já é um administrador e, portanto, a chave é preenchida automaticamente.

  4. Selecione Enviar.

    Quando a solicitação for realizada com sucesso, o back-end responderá com 200 OK e alguns dados.

Acrescentar outras APIs

Você pode compor uma API a partir de APIs que são disponibilizadas por diferentes serviços, incluindo:

  • Uma especificação do OpenAPI
  • Uma API SOAP
  • Uma API da GraphQL
  • Um aplicativo Web hospedado no Serviço de Aplicativo do Azure
  • Funções do Azure
  • Aplicativos Lógicos do Azure
  • Azure Service Fabric

Observação

Quando você importa uma API, as operações são acrescentadas à API atual.

Para acrescentar uma API a uma API existente:

  1. Acesse sua instância de Gerenciamento de API do Azure no portal do Azure:

    Captura de tela que mostra a página Serviços de Gerenciamento de API.

  2. Selecione APIs na página Visão geral ou selecione APIs APIs> no menu à esquerda.

    Captura de tela que mostra a seleção de APIs na página Visão geral.

  3. Selecione as reticências (...) próximas à API na qual deseja acrescentar outra API.

  4. Selecione Importar no menu suspenso:

    Captura de tela que mostra o comando Importar.

  5. Selecione um serviço de onde será importada a API.

Conteúdo relacionado