Sdílet prostřednictvím


Import aplikace kontejneru Azure jako rozhraní API

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

Tento článek popisuje, jak importovat aplikaci kontejneru Azure do služby Azure API Management jako rozhraní API a otestovat importované rozhraní API pomocí webu Azure Portal.

Poznámka:

V současné době tato funkce není dostupná v pracovních prostorech.

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

  • Import aplikace kontejneru, která zpřístupň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 s upřednostňovaným programovacím jazykem nebo architekturou, 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í.

Použitím služby API Management ke zpřístupnění webového rozhraní API hostovaného v kontejnerové aplikaci získáte následující výhody:

  • Oddělení správy a zabezpečení front-endu, který je vystaven uživatelům rozhraní API, od správy a monitorování back-endového webového rozhraní API
  • Spravujte webová rozhraní API hostovaná jako kontejnerové aplikace ve stejném prostředí jako ostatní rozhraní API.
  • Aplikujte politiky ke změně chování API, například omezení rychlosti volání.
  • Nasměrujte uživatele rozhraní API na přizpůsobitelný vývojářský portál služby API Management, aby mohli objevit a naučit se o vašich rozhraních API, vyžádat si přístup a vyzkoušet rozhraní API.

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

Specifikace OpenAPI vs. operace se zástupnými znaky

API Management podporuje import aplikací kontejnerů, které poskytují specifikaci OpenAPI (definici Swaggeru). Specifikace OpenAPI není nutná, ale doporučujeme ji zadat. API Management může importovat jednotlivé operace, které umožňují ověřovat, spravovat, zabezpečit a aktualizovat konfigurace pro každou operaci samostatně.

Pokud aplikace kontejneru zveřejňuje specifikaci OpenAPI, služba API Management vytvoří operace rozhraní API, které se mapují přímo na definici. Služba API Management hledá na několika místech specifikaci OpenAPI.

  • Konfigurace aplikace kontejneru
  • /openapi.json
  • /openapi.yml
  • /swagger/v1/swagger.json

Pokud není k dispozici specifikace OpenAPI, služba API Management vygeneruje zástupné operace pro běžné HTTP operátory (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://<app-service>.azurewebsites.net/customer/{id}
  • https://<app-service>.azurewebsites.net/customers

Aplikaci kontejneru naimportujete do služby API Management na cestě, jako je https://<api>.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://<api>.azure-api.net/store/customer/1

GET https://<api>.azure-api.net/store/customers
Divoká karta GET /* GET https://contosoapi.azure-api.net/store/customer/1

GET https://<api>.azure-api.net/store/customers

Operace se zástupným znakem umožňuje zadávání stejných požadavků pro backendovou službu jako operace ve specifikaci OpenAPI. Zadané operace OpenAPI se ale dají spravovat samostatně ve službě API Management.

Požadavky

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

  1. Na webu Azure Portal přejděte ke službě API Management a v levém podokně vyberte rozhraní API>rozhraní API.

  2. V části Vytvořit z prostředku Azure vyberte Kontejnerová aplikace:

    Snímek obrazovky znázorňující dlaždici Kontejnerová aplikace

  3. Výběrem možnosti Procházet zobrazíte seznam kontejnerových aplikací ve vašem předplatném.

  4. Vyberte aplikaci typu kontejner. Pokud je definice OpenAPI přidružená k vybrané aplikaci kontejneru, služba API Management ji načte a naimportuje. Pokud se definice OpenAPI nenajde, služba API Management zpřístupní API generováním operací se zástupnými symboly pro běžné příkazy HTTP.

  5. Přidejte příponu API URL. Sufix je název, který identifikuje API v instanci API Management. Musí být jedinečný v instanci služby API Management.

  6. Přidružte rozhraní API k produktu. Vyberte Úplné a pak v části Produkt vyberte produkt. V tomto případě se používá neomezený produkt. Pokud chcete, aby se rozhraní API publikovalo a bylo dostupné vývojářům, musíte ho přidat do produktu.

    Poznámka:

    Produkty jsou přidružení 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. Když se přihlásí k odběru, získá klíč předplatného, který je vhodný pro jakékoli rozhraní API v dané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.

    V některých cenových úrovních se instance služby API Management při vytváření dodává se dvěma ukázkovými produkty:

    • Předkrm
    • Neomezený
  7. Zadejte další nastavení rozhraní API. Tyto hodnoty můžete nastavit při vytváření rozhraní API nebo je později nakonfigurovat na kartě Nastavení . Tato nastavení jsou vysvětlená v kurzu importu a publikování vašeho prvního kurzu rozhraní API .

  8. Vyberte Vytvořit.

    Snímek obrazovky znázorňující okno Vytvořit z aplikace kontejneru

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

Operace můžete používat přímo z Azure Portálu. Tato metoda představuje pohodlný způsob zobrazení a testování operací rozhraní API. API můžete také otestovat v portálu pro vývojáře nebo pomocí vlastních nástrojů REST klienta.

Testování rozhraní API na webu Azure Portal:

  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. Jednou z hlaviček je Ocp-Apim-Subscription-Key. Tato hlavička je určená pro klíč předplatného produktu, který je přidružený k rozhraní API. Pokud jste vytvořili instanci služby API Management, jste správce, takže klíč se vyplní automaticky.

  4. Vyberte 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 znaky, nemusí se přímo přiřadit k back-endovému 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

Postup otestování /api/TodoItems cesty:

  1. Vyberte rozhraní API, které jste vytvořili, a pak vyberte operaci.

  2. Vyberte kartu Test.

  3. V parametrech šablony aktualizujte hodnotu vedle názvu se zástupným znakem (*). Například zadejte api/TodoItems. Tato hodnota je připojena k cestě / pro operaci se zástupným znakem.

    Snímek obrazovky znázorňující kroky pro testování operace se zástupnými  znaky

  4. Vyberte Odeslat.

Připojení dalších rozhraní API

Můžete vytvořit rozhraní API z rozhraní API, která jsou poskytovaná různými službami, včetně:

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

Poznámka:

Při importu rozhraní API se operace připojí k aktuálnímu rozhraní API.

Připojení API k existujícímu API:

  1. Na webu Azure Portal přejděte do své instance služby Azure API Management:

    snímek obrazovky se stránkou služby API Management

  2. Na stránce přehledu vyberte rozhraní API nebo v nabídce vlevo vyberte rozhraní API>.

    Snímek obrazovky znázorňující výběr rozhraní API na stránce Přehled

  3. Vyberte ikonu se třemi tečkami (...) vedle rozhraní API, k němuž chcete přidat další rozhraní API.

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

    Snímek obrazovky s příkazem Importovat

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