Import rozhraní API SOAP do služby API Management

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

Import rozhraní API back-endu

  1. Na webu Azure Portal přejděte k vaší instanci služby API Management.

  2. V nabídce vlevo vyberte rozhraní API> + Přidat rozhraní API.

  3. V části Vytvořit z definice vyberte WSDL.

    Rozhraní API protokolu SOAP

  4. Ve specifikaci WSDL zadejte adresu URL rozhraní SOAP API nebo klikněte na vybrat soubor a vyberte místní soubor WSDL.

  5. 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.

    Vytvoření rozhraní API SOAP ze specifikace WSDL

  6. 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.

  7. 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 .

  8. Vyberte Vytvořit.

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.

  1. Vyberte rozhraní API, které jste vytvořili v předchozím kroku.

  2. Vyberte kartu Test.

  3. 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.

  4. 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:

  1. Na portálu vyberte rozhraní API, které jste vytvořili v předchozím kroku.
  2. Na kartě Návrh vyberte + Přidat operaci.
  3. Zadejte zobrazovaný název operace.
  4. 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í.

Poznámka:

K úpravě rozhraní API SOAP nepoužívejte editor specifikace OpenAPI na kartě Návrh .

Připojení dalších rozhraní API

Můžete vytvořit rozhraní API rozhraní API vystavených různými službami, mezi které patří:

  • Specifikace OpenAPI
  • Rozhraní API SOAP
  • Rozhraní GraphQL API
  • Webová aplikace hostovaná ve službě Aplikace Azure Service
  • Aplikace funkcí Azure
  • Azure Logic Apps
  • Azure Service Fabric

Pomocí následujícího postupu připojte k existujícímu rozhraní API jiné rozhraní API.

Poznámka:

Při importu dalšího rozhraní API se k aktuálnímu rozhraní API připojí příslušné operace.

  1. Na webu Azure Portal přejděte do instance Azure API Management.

    Přejít do instance Mgmt rozhraní Azure API

  2. Na stránce Přehled nebo v nabídce vlevo vyberte rozhraní API.

    Výběr rozhraní API

  3. Klikněte na vedle rozhraní API, ke kterému chcete připojit jiné rozhraní API.

  4. V rozevírací nabídce vyberte Importovat.

    Výběr importu

  5. Vyberte službu, ze které se má importovat rozhraní API.

    Výběr služby

Další kroky