Importar API SOAP para o Gerenciamento de API

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

Este artigo mostra como importar uma especificação WSDL, que é uma representação XML padrão de uma API SOAP. O artigo também mostra como testar a API no Gerenciamento de API.

Neste artigo, vai aprender a:

Pré-requisitos

• Uma instância de gerenciamento de API. Se você ainda não tiver uma, conclua o seguinte início rápido: Criar uma instância de Gerenciamento de API do Azure.

• CLI do Azure

  • Use o ambiente Bash no Azure Cloud Shell. Para mais informações, veja Get started with Azure Cloud Shell.

    

  • Se preferir executar comandos de referência da CLI localmente, instale a CLI do Azure. Se estiver a utilizar o Windows ou macOS, considere executar a CLI do Azure num contentor Docker. Para obter mais informações, consulte Como executar a CLI do Azure em um contêiner do Docker.

    • Se estiver a utilizar uma instalação local, inicie sessão no CLI do Azure ao utilizar o comando az login. Para concluir o processo de autenticação, siga os passos apresentados no seu terminal. Para outras opções de entrada, consulte Autenticar no Azure usando a CLI do Azure.

    • Quando solicitado, instale a extensão da CLI do Azure na primeira utilização. Para obter mais informações sobre extensões, consulte Usar e gerenciar extensões com a CLI do Azure.

    • Execute o comando az version para localizar a versão e as bibliotecas dependentes instaladas. Para atualizar para a versão mais recente, execute o comando az upgrade.

• Azure PowerShell

  • Se você optar por usar o Azure PowerShell localmente:
    • Instale a versão mais recente do módulo Az PowerShell.
    • Conecte-se à sua conta do Azure usando o cmdlet Connect-AzAccount .
  • Se você optar por usar o Azure Cloud Shell:
    • Consulte Visão geral do Azure Cloud Shell para obter mais informações.

Importar uma API de back-end

# API Management service-specific details
APIMServiceName="apim-hello-world"
ResourceGroupName="myResourceGroup"

# API-specific details
APIId="order-api"
APIPath="order"
SpecificationFormat="Wsdl"
SpecificationURL="https://fazioapisoap.azurewebsites.net/FazioService.svc?singleWsdl"
WsdlServiceName="OrdersAPI"
WsdlEndpointName="basic"

# Import API
az apim api import --path $APIPath --resource-group $ResourceGroupName \
    --service-name $APIMServiceName --api-id $APIId \
    --specification-format $SpecificationFormat --specification-url $SpecificationURL \
    --wsdl-service-name $WsdlServiceName --wsdl-endpoint-name $WsdlEndpointName

# API Management service-specific details
$apimServiceName = "apim-hello-world"
$resourceGroupName = "myResourceGroup"

# API-specific det
$apiId = "orders-api"
$apiPath = "orders"
$specificationFormat = "Wsdl"
$specificationUrl = "https://fazioapisoap.azurewebsites.net/FazioService.svc?singleWsdl"
$wsdlServiceName = "OrdersAPI"
$wsdlEndpointName = "basic"

# Get context of the API Management instance. 
$context = New-AzApiManagementContext -ResourceGroupName $resourceGroupName -ServiceName $apimServiceName

# Import API
Import-AzApiManagementApi -Context $context -ApiId $apiId -SpecificationFormat $specificationFormat -SpecificationUrl $specificationUrl -Path $apiPath -WsdlServiceName $wsdlServiceName -WsdlEndpointName $wsdlEndpointName

Teste a nova API no portal

As operações podem ser chamadas diretamente do portal, o que fornece uma maneira conveniente para os administradores visualizarem e testarem as operações de uma API.

1. Selecione a API que criou no passo anterior.

2. Selecione o separador Teste.

3. Selecione uma operação. A página apresenta campos para os parâmetros de consulta e campos para os cabeçalhos.

   Nota

   No console de teste, a Gestão de API preenche automaticamente um cabeçalho Ocp-Apim-Subscription-Key e configura a chave de assinatura da assinatura interna de acesso total. Essa chave permite o acesso a todas as APIs na instância de Gerenciamento de API. Opcionalmente, mostre o cabeçalho Ocp-Apim-Subscription-Key ao selecionar o ícone de "olho" ao lado da Solicitação HTTP.

4. Dependendo da operação, insira valores de parâmetros de consulta, valores de cabeçalho ou um corpo de solicitação. Selecione Enviar.

   Quando o teste é bem-sucedido, o back-end responde com um código de resposta HTTP bem-sucedido e alguns dados.

   Gorjeta

   Por padrão, o console de teste envia uma solicitação para o proxy CORS do Gerenciamento de API, que encaminha a solicitação para a instância de Gerenciamento de API, que a encaminha para o back-end. Este proxy usa o endereço IP público 13.91.254.72 e só pode aceder a endpoints públicos. Se quiser enviar uma solicitação diretamente do navegador para o serviço de Gerenciamento de API, selecione Ignorar proxy CORS. Use essa opção quando quiser usar o console de teste e seu gateway de Gerenciamento de API estiver isolado na rede ou não permitir tráfego do proxy CORS.

Para depurar uma API, consulte Tutorial: Depurar suas APIs usando o rastreamento de solicitações.

Ação SOAP coringa

Se você precisar passar uma solicitação SOAP que não tenha uma ação dedicada definida na API, poderá configurar uma ação SOAP curinga. A ação carta-branca corresponderá a qualquer solicitação SOAP que não esteja definida na API.

Para definir uma ação curinga do SOAP:

1. No portal, selecione a API que você criou na etapa anterior.
2. Na guia Design, selecione + Adicionar operação.
3. Insira um Nome de exibição para a operação.
4. Na URL, selecione POST e insira /?soapAction={any} no recurso. O parâmetro template dentro dos colchetes é arbitrário e não afeta a execução.

Anexar outras APIs

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

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

Para acrescentar uma API a uma API existente:

1. Vá para sua instância de Gerenciamento de API do Azure no portal do Azure:

   

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

   

3. Selecione as reticências (...) ao lado da API à qual deseja acrescentar outra API.

4. Selecione Importar a partir do menu suspenso:

   

5. Selecione um serviço a partir do qual quer importar uma API.

Conteúdo relacionado

• Limitações de importação de API
• Importar uma especificação de OpenAPI
• Importar uma API SOAP
• Importe uma API SOAP e converta-a em REST
• Importar uma API do Serviço de Aplicativo
• Importar uma API de aplicativo de contêiner
• Importar uma API WebSocket
• Importar uma GraphQL API
• Importar um esquema de GraphQL e configurar resolvers de campos
• Importar uma API de aplicativo de função
• Importar uma API de aplicativo lógico
• Importar um serviço do tipo Service Fabric
• Importar uma API do Azure AI Foundry
• Importar uma API OpenAI do Azure
• Importar uma API LLM
• Importar uma API OData
• Importar metadados do SAP OData
• Importar uma API gRPC
• Editar uma API