Import aplikace kontejneru Azure jako rozhraní API

Článek
11/08/2023

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

Tento článek ukazuje, jak importovat aplikaci Kontejner Azure do služby Azure API Management a otestovat importované rozhraní API pomocí webu Azure Portal. V tomto článku získáte informace o těchto tématech:

Import kontejnerové aplikace, která zveřejňuje webové rozhraní API
Testovat rozhraní API na portálu Azure Portal

Zveřejnění kontejnerové aplikace pomocí služby API Management

Azure Container Apps umožňuje nasazovat kontejnerizované aplikace bez nutnosti spravovat složitou infrastrukturu. Vývojáři rozhraní API můžou psát kód pomocí preferovaného programovacího jazyka nebo architektury, vytvářet mikroslužby s plnou podporou distribuovaného modulu Application Runtime (Dapr) a škálovat na základě provozu HTTP nebo jiných událostí.

Služba API Management je doporučené prostředí pro zveřejnění webového rozhraní API hostované službou Container App z několika důvodů:

Oddělení správy a zabezpečení front-endu vystaveného uživatelům rozhraní API od správy a monitorování back-endového webového rozhraní API
Správa webových rozhraní API hostovaných jako Container Apps ve stejném prostředí jako ostatní rozhraní API
Použití zásad ke změně chování rozhraní API, jako je omezování četnosti volání
Přímé uživatele rozhraní API na přizpůsobitelný vývojářský portál služby API pro zjišťování a získání informací o rozhraních API, vyžádání přístupu a jejich vyzkoušení

Další informace najdete v tématu o službě API Management.

Specifikace OpenAPI versus operace se zástupnými cardy

API Management podporuje import kontejnerových aplikací, které poskytují specifikaci OpenAPI (definici Swaggeru). Specifikace OpenAPI se však nevyžaduje. Doporučujeme poskytnout specifikaci OpenAPI. SLUŽBA API Management může importovat jednotlivé operace, což umožňuje ověřovat, spravovat, zabezpečit a aktualizovat konfigurace pro každou operaci samostatně.

Pokud kontejnerová aplikace zveřejňuje specifikaci OpenAPI, služba API Management vytvoří operace rozhraní API, které se mapují přímo na definici. Služba API Management bude hledat v několika umístěních specifikaci OpenAPI.

Konfigurace kontejnerové aplikace.
/openapi.json
/openapi.yml
/swagger/v1/swagger.json

Pokud není k dispozici specifikace OpenAPI, služba API Management vygeneruje operace se zástupnými výjimkou pro běžné příkazy HTTP (GET, PUT atd.). Stále můžete využívat stejné funkce služby API Management, ale operace nejsou definované na stejné úrovni podrobností.

V obou případech můžete po importu upravit nebo přidat operace do rozhraní API.

Příklad

Vaše back-endová aplikace kontejneru může podporovat dvě operace GET:

https://myappservice.azurewebsites.net/customer/{id}
https://myappservice.azurewebsites.net/customers

Aplikaci kontejneru naimportujete do služby API Management na cestě, například https://contosoapi.azure-api.net/store. V následující tabulce jsou uvedeny operace importované do služby API Management, a to buď se specifikací OpenAPI, nebo bez této specifikace:

Typ	Importované operace	Ukázkové požadavky
Specifikace OpenAPI	`GET /customer/{id}` `GET /customers`	`GET https://contosoapi.azure-api.net/store/customer/1` `GET https://contosoapi.azure-api.net/store/customers`
Divoká karta	`GET /*`	`GET https://contosoapi.azure-api.net/store/customer/1` `GET https://contosoapi.azure-api.net/store/customers`

Operace se zástupným znakem umožňuje stejným požadavkům na back-endovou službu jako operace ve specifikaci OpenAPI. Zadané operace OpenAPI se ale dají spravovat samostatně ve službě API Management.

Požadavky

Projděte si následující rychlý start: Vytvoření instance Azure API Managementu.
Ujistěte se, že je ve vašem předplatném k dispozici kontejnerová aplikace, která zveřejňuje webové rozhraní API. Další informace najdete v dokumentaci ke službě Container Apps.

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

Na webu Azure Portal vyhledejte a vyberte služby API Management.
Na stránce služby API Management vyberte instanci služby API Management.

Import a publikování back-endového rozhraní API

Na webu Azure Portal přejděte ke službě API Management a v nabídce vyberte rozhraní API .
V seznamu vyberte Kontejnerová aplikace .
Výběrem možnosti Procházet zobrazíte seznam kontejnerových aplikací ve vašem předplatném.
Vyberte aplikaci typu Kontejner. Pokud je definice OpenAPI přidružená k vybrané kontejnerové aplikaci, služba API Management ji načte a naimportuje. Pokud se definice OpenAPI nenajde, služba API Management toto rozhraní api zveřejní generováním operací se zástupnými výjimkou pro běžné příkazy HTTP.
Přidejte příponu adresy URL rozhraní API. Přípona je název, který identifikuje toto konkrétní rozhraní API v této instanci služby API Management. Musí být jedinečný v této instanci služby API Management.
Publikujte rozhraní API jeho přidružením k produktu. V tomto případě se použije produkt Unlimited. Pokud chcete, aby se rozhraní API publikovalo a bylo dostupné vývojářům, přidejte ho do produktu.
Poznámka:

Produkty jsou sdruženími jednoho nebo více rozhraní API. Můžete zahrnout mnoho rozhraní API a nabídnout je vývojářům prostřednictvím portálu pro vývojáře. Vývojáři se nejprve musí přihlásit k odběru produktu, a teprve pak získají přístup k rozhraní API. Po přihlášení k odběru získají klíč předplatného, který je možné použít pro jakékoli rozhraní API v příslušném produktu. Pokud jste vytvořili instanci služby API Management, jste správce a ve výchozím nastavení jste přihlášeni k odběru každého produktu.

Každá instance služby API Management má při vytváření dva ukázkové produkty:
- Starter
- Unlimited
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í. Nastavení jsou vysvětlená v kurzu Import a publikování vašeho prvního kurzu rozhraní API.
Vyberte Vytvořit.

Testování nového rozhraní API na webu Azure Portal

Operaci můžete volat přímo z portálu Azure Portal, který nabízí pohodlný způsob pro zobrazení a testování operací v rozhraní API. Rozhraní API můžete také otestovat na portálu pro vývojáře nebo pomocí vlastních klientských nástrojů REST.

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. Jednou z hlaviček je Ocp-Apim-Subscription-Keyklíč předplatného produktu, který je přidružený k tomuto rozhraní API. Pokud jste vytvořili instanci služby API Management, jste už správcem a klíč se tedy vyplní automaticky.
Stiskněte Odeslat.

Pokud je test úspěšný, back-end odpoví s 200 OK a některými daty.

Test operace se zástupnými znaky na portálu

Když se vygenerují operace se zástupnými cardy, nemusí se operace mapovat přímo na back-endové rozhraní API. Například operace GET se zástupným znakem importovaným ve službě API Management ve výchozím nastavení používá cestu / . Vaše back-endové rozhraní API ale může podporovat operaci GET na následující cestě:

/api/TodoItems

Cestu /api/TodoItems můžete otestovat následujícím způsobem.

Vyberte rozhraní API, které jste vytvořili, a vyberte operaci.
Vyberte kartu Test.
V parametrech šablony aktualizujte hodnotu vedle názvu se zástupným znakem (*). Například zadejte api/TodoItems. Tato hodnota se připojí k cestě / pro operaci se zástupným znakem.
Vyberte Odeslat.