Import rozhraní OData API

  • Článek

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

Tento článek ukazuje, jak importovat službu kompatibilní s OData jako rozhraní API ve službě API Management.

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

  • Import popisu metadat OData pomocí webu Azure Portal
  • Správa schématu OData na portálu
  • Zabezpečení rozhraní OData API

Poznámka:

Import služby OData jako rozhraní API z popisu metadat je ve verzi Preview.

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.

  • Služba vystavená jako OData v2 nebo v4.

Přejít k instanci služby API Management

  1. Na webu Azure Portal vyhledejte a vyberte služby API Management.

    Výběr služeb API Management

  2. Na stránce služby API Management vyberte instanci služby API Management.

    Výběr instance služby API Management

Import metadat OData

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

  2. V části Vytvořit z definice vyberte OData.

    Snímek obrazovky s vytvořením rozhraní API z popisu OData na portálu

  3. Zadejte nastavení rozhraní API. Později můžete nastavení aktualizovat tak, že přejdete na kartu Nastavení rozhraní API.

    1. Ve specifikaci OData zadejte adresu URL koncového bodu metadat OData, obvykle adresu URL kořenového adresáře služby, která je připojena ./$metadata Případně vyberte místní soubor XML OData, který chcete importovat.

    2. Zadejte zbývající nastavení pro konfiguraci rozhraní API. Tato nastavení jsou vysvětlená v kurzu importu a publikování vašeho prvního kurzu rozhraní API .

  4. Vyberte Vytvořit.

    Rozhraní API se přidá do seznamu rozhraní API . Sady entit a funkce, které jsou zveřejněné v popisu metadat OData, se zobrazí na kartě Sady entit a funkce rozhraní API.

    Snímek obrazovky se sadami a funkcemi entit OData na portálu

Aktualizace schématu OData

K editoru na portálu se dostanete a zobrazí se schéma OData vašeho rozhraní API. Pokud se rozhraní API změní, můžete schéma ve službě API Management aktualizovat také ze souboru nebo koncového bodu služby OData.

  1. Na portálu přejděte do vaší instance služby API Management.

  2. V nabídce vlevo vyberte rozhraní API> vašeho rozhraní OData API.

  3. Na kartě Sady entit a funkce vyberte místní nabídku (...) vedle sady nebo funkce entity a vyberte Upravit.

    Snímek obrazovky s místní nabídkou pro entitu OData nastavenou na portálu

  4. Zkontrolujte schéma. Pokud ho chcete aktualizovat, vyberte Možnost Aktualizovat ze souboru nebo Aktualizovat schéma z koncového bodu.

    Snímek obrazovky s editorem schémat pro rozhraní API OData na portálu

Testování rozhraní API OData

  1. V nabídce vlevo vyberte rozhraní API> vašeho rozhraní OData API.

  2. Na kartě Sady entit a funkce vyberte místní nabídku (...) vedle sady entit nebo funkce a vyberte Test.

    Snímek obrazovky s možností Test v místní nabídce pro entitu OData nastavenou na portálu

  3. V testovací konzole zadejte parametry šablony, parametry dotazu a hlavičky testu a vyberte Test. Přečtěte si další informace o testování rozhraní API na portálu.

Zabezpečení rozhraní OData API

Zabezpečte své rozhraní API OData použitím stávajících zásad ověřování a autorizace a zásad ověřování OData, které chrání před útoky prostřednictvím požadavků rozhraní OData API.

Tip

Na portálu nakonfigurujte zásady pro vaše rozhraní API OData na kartě Zásady rozhraní API.

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