Importera SOAP API till API Management

Artikel
02/03/2024

GÄLLER FÖR: Alla API Management-nivåer

Den här artikeln visar hur du importerar en WSDL-specifikation, som är en standard-XML-representation av ett SOAP-API. Artikeln visar också hur du testar API:et i API Management.

I den här artikeln kan du se hur du:

Importera ett SOAP-API
Testa API:et i Azure Portal

Kommentar

WSDL-import till API Management omfattas av vissa begränsningar. WSDL-filer med wsdl:import, xsd:importoch xsd:include -direktiv stöds inte. Ett verktyg med öppen källkod för att lösa och sammanfoga dessa beroenden i en WSDL-fil finns i den här GitHub-lagringsplatsen.

Förutsättningar

En API Management-instans. Om du inte redan har en, slutför du följande snabbstart: Skapa en Azure API Management-instans.
Azure CLI
- Använd Bash-miljön i Azure Cloud Shell. Mer information finns i Snabbstart för Bash i Azure Cloud Shell.
- Om du föredrar att köra CLI-referenskommandon lokalt installerar du Azure CLI. Om du kör i Windows eller macOS kan du köra Azure CLI i en Docker-container. Mer information finns i Så här kör du Azure CLI i en Docker-container.
  - Om du använder en lokal installation loggar du in på Azure CLI med hjälp av kommandot az login. Slutför autentiseringsprocessen genom att följa stegen som visas i terminalen. Andra inloggningsalternativ finns i Logga in med Azure CLI.
  - När du uppmanas att installera Azure CLI-tillägget vid första användningen. Mer information om tillägg finns i Använda tillägg med Azure CLI.
  - Kör az version om du vill hitta versionen och de beroende bibliotek som är installerade. Om du vill uppgradera till den senaste versionen kör du az upgrade.
Azure PowerShell
- Om du väljer att använda Azure PowerShell lokalt:
  - Installera den senaste versionen av Az PowerShell-modulen.
  - Anslut till ditt Azure-konto med cmdleten Anslut-AzAccount.
- Om du väljer att använda Azure Cloud Shell:
  - Mer information finns i Översikt över Azure Cloud Shell .

Importera ett serverdels-API

I Azure-portalen går du till din API Management-instans.
I den vänstra menyn väljer du API:er>+ Lägg till API.
Under Skapa från definition väljer du WSDL.
I WSDL-specifikationen anger du URL:en till SOAP-API:et eller klickar på Välj en fil för att välja en lokal WSDL-fil.
I Import-metoden väljs SOAP-direkt som standard. Med det här valet exponeras API:et som SOAP och API-konsumenter måste använda SOAP-regler. Om du vill ”restify” API:et, följer du stegen i Importera ett SOAP API och konvertera det till REST.
Följande API-inställningar fylls i automatiskt baserat på information från SOAP-API:et: Visningsnamn, Namn, Beskrivning. Åtgärderna fylls automatiskt i med Visningsnamn, URL och Beskrivning och får ett systemgenererat namn.
Ange andra API-inställningar. Du kan ange värdena när du skapar eller konfigurera dem senare genom att gå till fliken Inställningar.

Mer information om API-inställningar finns i Importera och publicera din första API-självstudie .
Välj Skapa.

I följande exempel används kommandot az apim api import för att importera en WSDL-specifikation från den angivna URL:en till en API Management-instans med namnet apim-hello-world. Om du vill importera med hjälp av en sökväg till en specifikation i stället för en URL använder du parametern --specification-path .

I det här exemplet är WSDL tjänstnamnet OrdersAPI och en av de tillgängliga slutpunkterna (gränssnitten) är grundläggande.

# 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

I följande exempel används Azure PowerShell-cmdleten Import-AzApiManagementApi för att importera en WSDL-specifikation från den angivna URL:en till en API Management-instans med namnet apim-hello-world. Om du vill importera med hjälp av en sökväg till en specifikation i stället för en URL använder du parametern -SpecificationPath .

I det här exemplet är WSDL tjänstnamnet OrdersAPI och en av de tillgängliga slutpunkterna (gränssnitten) är grundläggande.

# 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

Testa det nya API:et i portalen

Åtgärder kan anropas direkt från portalen, vilket är ett bekvämt sätt för administratörer att visa och testa åtgärderna i ett API.

Välj det API som du skapade i föregående steg.
Välj fliken Test.
Välj en åtgärd. Sidan visar fält för frågeparametrar och fält för sidhuvudena.

Kommentar

I testkonsolen fyller API Management automatiskt i huvudet Ocp-Apim-Subscription-Key och konfigurerar prenumerationsnyckeln för den inbyggda all-access-prenumerationen. Den här nyckeln ger åtkomst till varje API i API Management-instansen. Du kan också visa huvudet Ocp-Apim-Subscription-Key genom att välja "öga"-ikonen bredvid HTTP-begäran.
Beroende på åtgärden anger du frågeparametervärden, rubrikvärden eller en begärandetext. Välj Skicka.

När testet lyckas svarar serverdelen med en lyckad HTTP-svarskod och vissa data.

Dricks

Som standard skickar testkonsolen en begäran till API Managements CORS-proxy, som vidarebefordrar begäran till API Management-instansen, som sedan vidarebefordrar den till serverdelen. Den här proxyn använder den offentliga IP-adressen 13.91.254.72 och kan bara nå offentliga slutpunkter. Om du vill skicka en begäran direkt från webbläsaren till API Management-tjänsten väljer du Kringgå CORS-proxy. Använd det här alternativet när du vill använda testkonsolen och DIN API Management-gateway är nätverksisolerad eller inte tillåter trafik från CORS-proxyn.

Information om hur du felsöker ett API finns i Självstudie: Felsöka dina API:er med hjälp av spårning av begäranden.

Soap-åtgärd med jokertecken

Om du behöver skicka en SOAP-begäran som inte har en dedikerad åtgärd definierad i API:et kan du konfigurera en SOAP-åtgärd med jokertecken. Jokerteckenåtgärden matchar alla SOAP-begäranden som inte har definierats i API:et.

Så här definierar du en SOAP-åtgärd med jokertecken:

I portalen väljer du det API som du skapade i föregående steg.
På fliken Design väljer du + Lägg till åtgärd.
Ange ett visningsnamn för åtgärden.
I URL:en väljer du POST och anger /soapAction={any} i resursen. Mallparametern inom klammerparenteserna är godtycklig och påverkar inte körningen.