Migrace portálu API pomocí plánu Azure Spring Apps Enterprise do služby Azure API Management

Poznámka:

Plány Basic, Standard a Enterprise budou od poloviny března 2025 vyřazeny ze 3letého období vyřazení. Doporučujeme přejít na Azure Container Apps. Další informace najdete v oznámení o vyřazení Azure Spring Apps.

Od 30. září 2024 bude od 30. září 2024 zastaralý plán s úplným vypnutím po šesti měsících. Doporučujeme přejít na Azure Container Apps. Další informace najdete v tématu Migrace spotřeby Azure Spring Apps Úrovně Standard a vyhrazeného plánu do Azure Container Apps.

Tento článek se vztahuje na: ❎ Basic/Standard ✅ Enterprise

Tento článek popisuje, jak migrovat rozhraní API Portal do služby Azure API Management.

Azure API Management poskytuje centralizované rozhraní pro zobrazení definic rozhraní API a testování konkrétních tras rozhraní API přímo z prohlížeče. Podporuje také jednotné přihlašování (SSO) pro lepší zabezpečení a bezproblémový přístup. Migrace z portálu API pomocí Azure Spring Apps do služby Azure API Management vylepšuje škálovatelnost, zabezpečení a integraci s dalšími službami Azure.

Požadavky

• Existující instance plánu Azure Spring Apps Enterprise s povoleným portálem API
• Existující aplikace kontejneru Azure. Další informace najdete v článku Rychlý start: Nasazení první aplikace kontejneru s využitím webu Azure Portal.

Vytvoření instance API Managementu

K vytvoření instance služby API Management použijte následující postup:

1. Na webu Azure Portal vyhledejte na panelu hledání službu API Management .

2. Ve výsledcích vyberte služby API Management a pak vyberte Vytvořit.

3. Zadejte následující požadované informace:

   • Předplatné: Vyberte předplatné Azure pro vaši službu.
   • Skupina prostředků: Vyberte existující skupinu prostředků nebo vyberte Vytvořit novou a vytvořte novou.
   • Oblast: Zvolte umístění nebo oblast vaší instance služby API Management.
   • Název prostředku: Zadejte globálně jedinečný název instance služby API Management.
   • Název organizace: Zadejte název vaší organizace.
   • E-mail správce: Zadejte e-mailovou adresu, která se používá pro oznámení související s instancí služby API Management.

4. Na základě vašeho případu použití zvolte cenovou úroveň. Cenovou úroveň můžete kdykoli upgradovat nebo změnit později.

5. Nakonfigurujte volitelná nastavení, jako je monitorování a nastavení virtuální sítě.

6. Výběrem možnosti Zkontrolovat a vytvořit zkontrolujte nastavení a ověřte konfiguraci.

7. Po dokončení ověření vyberte Vytvořit. Nasazení může trvat 30 až 40 minut.

8. Po dokončení nasazení přejděte na stránku služby API Management a zobrazte nově vytvořenou službu.

Import vystavených rozhraní API ve službě API Management

Ve službě API Management existují dvě možnosti importu rozhraní API: ruční přidávání rozhraní API nebo import souboru specifikace rozhraní API.

Ruční přidání rozhraní API

K ručnímu přidání rozhraní API použijte následující postup:

1. Na webu Azure Portal přejděte k instanci služby API Management. V části Rozhraní API vyberte Přidat rozhraní API.

2. V podokně Definovat nové rozhraní API vyberte možnost HTTP a ručně definujte rozhraní HTTP API.

3. Zadejte následující hodnoty základy rozhraní API a pak vyberte Vytvořit , které chcete uložit:

   • Zobrazovaný název: Zadejte název rozhraní API.
   • Název: Zadejte jedinečný identifikátor rozhraní API.
   • Adresa URL webové služby: Zadejte základní adresu URL back-endového rozhraní API vaší služby Container Apps.
   • Přípona adresy URL rozhraní API: Definujte příponu pro toto rozhraní API – například /api/customers-service.

4. Pokud chcete vytvořit nové koncové body rozhraní API, vyberte Přidat operaci a pak postupujte následovně:

   1. Zadejte obecné informace. Zobrazovaný název a název vstupu
   2. Zadejte podrobnosti o operaci, jako je příkaz HTTPGET - POST atd. – adresa URL, parametry dotazu, požadavek a odpověď.
   3. Po přidání všech operací uložte rozhraní API.

5. Vyberte názvy přidaných rozhraní API. Všechny operace přidané na kartě Návrh můžete zobrazit.

Import souboru specifikace rozhraní API

Pokud máte specifikaci OpenAPI – definici Swaggeru – vašich rozhraní API, můžete přímo importovat do služby API Management pomocí následujících kroků:

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

2. V části Rozhraní API otevřete část Rozhraní API.

3. Vyberte Přidat rozhraní API.

4. V části Vytvořit z definice zvolte možnost OpenAPI , která vytvoří standardní rozhraní nezávislé na jazyce na rozhraní REST API.

5. Pomocí následujících kroků vytvořte rozhraní API ze specifikace OpenAPI:

   1. Pokud máte místní soubor specifikace rozhraní API, vyberte Vyberte soubor , který chcete nahrát. Alternativně zadejte veřejně přístupnou adresu URL specifikace OpenAPI.
   2. Nastavení rozhraní API můžete dále upřesnit zadáním hodnot pro zobrazovaný název, název a příponu adresy URL rozhraní API.
   3. Konfigurace uložíte tak, že vyberete Vytvořit.

6. Vyberte název přidaných rozhraní API. Všechny operace přidané na kartě Návrh můžete zobrazit.

Vyzkoušení rozhraní API ve službě API Management

Azure API Management poskytuje integrovanou testovací konzolu na webu Azure Portal, která usnadňuje interakci s vašimi rozhraními API bez nutnosti externích nástrojů. K otestování rozhraní API použijte následující postup:

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

2. V části Rozhraní API vyberte ze seznamu rozhraní API, které chcete otestovat.

3. Zvolte operaci. Na stránce s přehledem rozhraní API můžete zobrazit seznam dostupných operací (koncových bodů). Vyberte operaci, kterou chcete otestovat.

4. Vyberte kartu Test a otevřete ji na webu Azure Portal.

5. Nakonfigurujte parametry požadavku. V závislosti na metodě rozhraní API zadejte potřebné parametry pro požadavek, jako jsou parametry cesty, parametry dotazu, hlavičky nebo text. Pokud rozhraní API vyžaduje , Authorization Tokennezapomeňte ho zahrnout do hlavičky.

6. Odešlete požadavek. Po zadání podrobností žádosti vyberte Odeslat. Odpověď z rozhraní API se zobrazí přímo na webu Azure Portal, včetně kódu odpovědi, textu odpovědi a hlaviček.

7. Zkontrolujte odpověď. Zkontrolujte data odpovědí, stavové kódy a všechny chybové zprávy, které můžou znamenat problémy s rozhraním API nebo požadavkem.

Migrace jednotného přihlašování do služby API Management

Pokud na portálu API povolíte jednotné přihlašování a chcete také ověřovat požadavky na službu API Management, nakonfigurujte identitu ve službě API Management pomocí následujícího postupu:

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

2. Přejděte na identity portálu>Pro vývojáře.

3. Vyberte Přidat a pak vyberte Azure Active Directory.

4. Vyplňte povinná pole:

   • ID klienta: Aplikace nebo ID klienta registrované aplikace Microsoft Entra ID.
   • Tajný klíč klienta: Tajný kód aplikace Microsoft Entra ID.
   • Přihlašovací tenant: Název domény tenanta Microsoft Entra ID, například yourcompany.onmicrosoft.com
   • Adresa URL pro přesměrování: obvykle https://{your-apim-instance}.developer.azure-api.net/signin.

5. Vyberte Přidat a uložte zprostředkovatele identity.

Před uložením nového přidaného zprostředkovatele identity musíte přidat adresu URL pro přesměrování do seznamu povolených adres URL pro přesměrování klientské aplikace Microsoft Entra ID.

Další konfigurace služby API Management najdete v dokumentaci ke službě API Management.