Import rozhraní API SOAP do služby API Management

Článek
10/24/2023

PLATÍ PRO: Všechny úrovně služby API Management

Tento článek ukazuje, jak importovat specifikaci WSDL, což je standardní reprezentace XML rozhraní SOAP API. Tento článek také ukazuje, jak otestovat rozhraní API ve službě API Management.

V tomto článku získáte informace o těchto tématech:

Import rozhraní API protokolu SOAP
Testovat rozhraní API na portálu Azure Portal

Poznámka:

Import WSDL do služby API Management podléhá určitým omezením. Soubory WSDL s wsdl:import, xsd:importa xsd:include direktivy nejsou podporovány. Opensourcový nástroj pro překlad a sloučení těchto závislostí v souboru WSDL najdete v tomto úložišti GitHubu.

Požadavky

Instance služby API Management. Pokud ho ještě nemáte, proveďte následující rychlý start: Vytvořte instanci služby Azure API Management.
Azure CLI
- Použijte prostředí Bash v Azure Cloud Shellu. Další informace najdete v tématu Rychlý start pro Bash v Azure Cloud Shellu.
- Pokud dáváte přednost místnímu spouštění referenčních příkazů rozhraní příkazového řádku, nainstalujte Azure CLI. Pokud používáte Windows nebo macOS, zvažte spuštění Azure CLI v kontejneru Docker. Další informace najdete v tématu Jak spustit Azure CLI v kontejneru Dockeru.
  - Pokud používáte místní instalaci, přihlaste se k Azure CLI pomocí příkazu az login. Pokud chcete dokončit proces ověřování, postupujte podle kroků zobrazených na terminálu. Další možnosti přihlášení najdete v tématu Přihlášení pomocí Azure CLI.
  - Po zobrazení výzvy nainstalujte rozšíření Azure CLI při prvním použití. Další informace o rozšířeních najdete v tématu Využití rozšíření v Azure CLI.
  - Spuštěním příkazu az version zjistěte verzi a závislé knihovny, které jsou nainstalované. Pokud chcete upgradovat na nejnovější verzi, spusťte az upgrade.
Azure PowerShell
- Pokud se rozhodnete používat Azure PowerShell místně:
  - Nainstalujte nejnovější verzi modulu Az PowerShell.
  - Připojení k účtu Azure pomocí rutiny Připojení-AzAccount.
- Pokud se rozhodnete použít Azure Cloud Shell:
  - Další informace najdete v přehledu služby Azure Cloud Shell .

Import rozhraní API back-endu

Na webu Azure Portal přejděte k vaší instanci služby API Management.
V nabídce vlevo vyberte rozhraní API> + Přidat rozhraní API.
V části Vytvořit z definice vyberte WSDL.
Ve specifikaci WSDL zadejte adresu URL rozhraní SOAP API nebo klikněte na vybrat soubor a vyberte místní soubor WSDL.
V metodě Import je ve výchozím nastavení vybrán předávací protokol SOAP. Díky tomuto výběru se rozhraní API zobrazí jako SOAP a uživatelé rozhraní API musí používat pravidla SOAP. Pokud chcete rozhraní API převést na REST, postupujte podle kroků v tématu o importování rozhraní API SOAP a jeho převedení na REST.
Následující nastavení rozhraní API se vyplní automaticky na základě informací z rozhraní API SOAP: Zobrazovaný název, Název, Popis. Operace se vyplní automaticky zobrazovaným názvem, adresou URL a popisem a obdrží systémem vygenerovaný název.
Zadejte další nastavení rozhraní API. Hodnoty můžete nastavit při vytváření nebo je později nakonfigurovat tak, že přejdete na kartu Nastavení.

Další informace o nastavení rozhraní API najdete v tématu Import a publikování prvního kurzu rozhraní API .
Vyberte Vytvořit.

Následující příklad používá příkaz az apim api import k importu specifikace WSDL ze zadané adresy URL do instance služby API Management s názvem apim-hello-world. Pokud chcete místo adresy URL importovat cestu ke specifikaci, použijte parametr --specification-path .

V tomto příkladu WSDL je název služby OrdersAPI a jeden z dostupných koncových bodů (rozhraní) je základní.

# 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

Následující příklad používá rutinu Azure PowerShellu Import-AzApiManagementApi k importu specifikace WSDL ze zadané adresy URL do instance služby API Management s názvem apim-hello-world. Pokud chcete místo adresy URL importovat cestu ke specifikaci, použijte parametr -SpecificationPath .

V tomto příkladu WSDL je název služby OrdersAPI a jeden z dostupných koncových bodů (rozhraní) je základní.

# 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

Testování nového rozhraní API na portálu

Operace je možné volat přímo z portálu, což správcům poskytuje pohodlný způsob zobrazení a testování operací rozhraní API.

Vyberte rozhraní API, které jste vytvořili v předchozím kroku.
Vyberte kartu Test.
Vyberte operaci. Stránka zobrazí pole pro parametry dotazu a pole pro hlavičky.

Poznámka:

V testovací konzole služba API Management automaticky naplní hlavičku klíče předplatného Ocp-Apim-Subscription-Key a nakonfiguruje klíč předplatného integrovaného předplatného s přístupem. Tento klíč umožňuje přístup ke každému rozhraní API v instanci služby API Management. Volitelně můžete zobrazit hlavičku Ocp-Apim-Subscription-Key výběrem ikony oka vedle požadavku HTTP.
V závislosti na operaci zadejte hodnoty parametrů dotazu, hodnoty hlaviček nebo text požadavku. Vyberte Odeslat.

Když je test úspěšný, back-end odpoví úspěšným kódem odpovědi HTTP a některými daty.

Tip

Ve výchozím nastavení testovací konzola odešle požadavek na proxy SERVER CORS služby API Management, který požadavek předá instanci služby API Management, která ji pak předá back-endu. Tento proxy server používá veřejnou IP adresu 13.91.254.72 a může se připojit pouze k veřejným koncovým bodům. Pokud chcete odeslat požadavek přímo z prohlížeče do služby API Management, vyberte Obejít proxy server CORS. Tuto možnost použijte, pokud chcete použít testovací konzolu a brána služby API Management je izolovaná v síti nebo nepovoluje provoz z proxy serveru CORS.

Pokud chcete ladit rozhraní API, projděte si kurz : Ladění rozhraní API pomocí trasování požadavků.

Akce SOAP se zástupnými cardy

Pokud potřebujete předat požadavek SOAP, který nemá definovanou vyhrazenou akci v rozhraní API, můžete nakonfigurovat akci PROTOKOLU SOAP se zástupnými znaky. Akce se zástupným znakem bude odpovídat požadavku SOAP, který není definovaný v rozhraní API.

Definování akce PROTOKOLU SOAP se zástupnými znaky:

Na portálu vyberte rozhraní API, které jste vytvořili v předchozím kroku.
Na kartě Návrh vyberte + Přidat operaci.
Zadejte zobrazovaný název operace.
V adrese URL vyberte POST prostředek a zadejte /soapAction={any} ho. Parametr šablony uvnitř složených závorek je libovolný a nemá vliv na provádění.