Kurz: Import a publikování prvního rozhraní API

Platí pro: Všechny úrovně API Management

V tomto kurzu se dozvíte, jak importovat back-endové rozhraní API specifikace OpenAPI ve formátu JSON do Azure API Management. V tomto příkladu importujete rozhraní API open source Petstore.

Tip

Týmy rozhraní API můžou tuto funkci používat v pracovních prostorech. Pracovní prostory poskytují izolovaný přístup pro správu k rozhraní API a jejich vlastní runtime prostředí rozhraní API.

Když naimportujete backend API do API Management, API Management API se stane bránou pro backend API. Bránu můžete přizpůsobit vašim potřebám v API Management beze změny back-endového rozhraní API. Další informace najdete v tématu Transformace a ochrana vašeho rozhraní API.

V tomto kurzu se naučíte:

  • Importujte rozhraní API do služby API Management
  • Zobrazení a úprava nastavení rozhraní API
  • Testování rozhraní API v Azure portal
  • Směrování požadavků rozhraní API prostřednictvím API Management

Po importu můžete rozhraní API spravovat v Azure portal.

Screenshot nového rozhraní API v API Management na portálu.

Požadavky

Přejděte na vaši instanci API Management

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

    Snímek obrazovky, který zobrazuje služby API Management ve výsledcích hledání.

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

    Snímek obrazovky, který zobrazuje instanci API Management na stránce služeb API Management.

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

Tato část ukazuje, jak importovat a publikovat back-endové rozhraní API specifikace OpenAPI.

  1. Ve vaší instanci API Managementu, v nabídce bočního panelu, přejděte do části APIs a vyberte APIs.

  2. Vyberte dlaždici OpenAPI

  3. V okně Vytvořit ze specifikace OpenAPI vyberte Úplné.

  4. Zadejte hodnoty z následující tabulky.

    Hodnoty rozhraní API můžete nastavit během vytváření nebo později tak, že přejdete na kartu Nastavení .

    Snímek obrazovky s vytvářením rozhraní API na portálu

    Nastavení Hodnota Popis
    Specifikace OpenAPI https://petstore3.swagger.io/api/v3/openapi.json nebo https://petstore.swagger.io/v2/swagger.json Určuje back-endovou službu, která implementuje rozhraní API, a operace, které rozhraní API podporuje.

    Adresa URL back-endové služby se později zobrazí jako adresa URL webové služby na stránce Nastavení rozhraní API.

    Po importu můžete do specifikace přidat, upravit, přejmenovat nebo odstranit operace.
    Zahrnutí parametrů dotazu do šablon operací Vybráno (výchozí) Určuje, jestli se mají v API Management importovat požadované parametry dotazu ve specifikaci jako parametry šablony.
    Zobrazované jméno Po zadání adresy URL specifikace OpenAPI API Management vyplní toto pole na základě formátu JSON. Název zobrazený na portálu vývojáře.
    Název Po zadání adresy URL specifikace OpenAPI API Management vyplní toto pole na základě formátu JSON. Jedinečný název rozhraní API.
    Popis Po zadání adresy URL specifikace OpenAPI API Management vyplní toto pole na základě formátu JSON. Volitelný popis rozhraní API.
    Schéma URL HTTPS Které protokoly mohou přistupovat k rozhraní API.
    Přípona adresy URL rozhraní API petstore Přípona připojená k základní adrese URL služby API Management. API Management rozlišuje a směruje rozhraní API podle jejich přípony, takže přípona musí být jedinečná pro každé rozhraní API pro daného vydavatele. Přečtěte si další informace o jak API Management směruje požadavky.
    Značky Značky pro uspořádání rozhraní API pro vyhledávání, seskupování nebo filtrování
    Produkty Unlimited Přidružení jednoho nebo více rozhraní API V některých úrovních má instance API Management dva ukázkové produkty: Starter a Unlimited. Rozhraní API publikujete na portálu pro vývojáře tím, že rozhraní API přidružujete k produktu.

    Do produktu můžete zahrnout několik rozhraní API a nabízet vývojářům předplatná produktů prostřednictvím portálu pro vývojáře. Pokud chcete toto rozhraní API přidat do jiného produktu, zadejte nebo vyberte název produktu. Opakováním tohoto kroku přidejte rozhraní API do více produktů. Rozhraní API můžete do produktů přidat také později na stránce Nastavení .

    Další informace o produktech naleznete v části Vytvoření a publikování produktu.
    Brány Spravované Brány rozhraní API, které jej zpřístupňují. Toto pole je k dispozici pouze ve službách úrovně Developer a Premium .

    Managed označuje bránu integrovanou do služby API Management a hostovanou Microsoftem v Azure. Samohostované brány jsou dostupné jenom na úrovních služeb Premium a Developer. Můžete je nasadit místně nebo v jiných cloudech.

    Pokud nevyberete žádné brány, rozhraní API není k dispozici a vaše požadavky rozhraní API nebudou úspěšné.
    Verzovat toto rozhraní API? Vybrat nebo zrušit výběr Další informace najdete v tématu Publikování více verzí rozhraní API.

  5. Výběrem Vytvořit vytvořte rozhraní API.

Pokud máte problémy s importem definice rozhraní API, podívejte se na omezení importu rozhraní API a známé problémy.

Zobrazení a úprava nastavení rozhraní API

Po importu rozhraní API můžete zobrazit a upravit jeho nastavení a operace v Azure portal.

  1. Ve vaší instanci API Managementu, v nabídce bočního panelu, přejděte do části APIs a vyberte APIs.

  2. Vyberte importované rozhraní API (například Swagger Petstore). Screenshot nastavení rozhraní API v API Management na portálu.

  3. Výběrem karty Návrh zobrazíte a upravíte operace rozhraní API ve specifikaci OpenAPI, včetně:

    • Podrobnosti o operaci, jako je adresa URL, metoda a popis
    • Definice požadavků a odpovědí
    • Zásady pro úpravu požadavků a odpovědí

  4. Výběrem karty Nastavení zobrazíte a upravíte podrobnosti konfigurace rozhraní API, včetně:

    • Zobrazovaný název, název a popis
    • Adresa URL webové služby (back-endová služba), schéma adres URL a přípona adresy URL rozhraní API
    • Produkty, značky a správa verzí
    • Pokročilejší nastavení, jako jsou požadavky na předplatné, zabezpečení a monitorování

Při procházení API Management kurzů se dozvíte více o konfiguraci nastavení rozhraní API. Tato nastavení můžete kdykoli aktualizovat, abyste přizpůsobili konfiguraci rozhraní API.

Otestování nového rozhraní API v Azure portal

Operace rozhraní API můžete volat přímo z Azure portal, což poskytuje pohodlný způsob zobrazení a testování operací. Ve výchozím nastavení jsou v portálové testovací konzole API volána pomocí klíče z integrovaného předplatného s úplným přístupem. Volání rozhraní API můžete testovat také pomocí klíče předplatného vztahujícího se k produktu.

  1. V instanci API Management vyberte APIs>APIs>Swagger Petstore.

  2. Vyberte kartu Test a pak vyberte Najít domácí zvířata podle stavu. Na stránce se zobrazuje stavparametr dotazu. Vyberte jednu z dostupných hodnot, například čekající na vyřízení. Tady můžete také přidat parametry dotazu a hlavičky.

    V části požadavku HTTP se automaticky vyplní hlavička Ocp-Apim-Subscription-Key, která se zobrazí, pokud vyberete ikonu oka.

  3. Vyberte Odeslat.

    Screenshot testování rozhraní API v Azure portal.

    Server odpovídá s 200 OK a poskytuje některá data.

Jak API Management směruje požadavky

API Management funguje jako brána mezi klienty rozhraní API a vašimi back-endovými službami. Když klient odešle požadavek na rozhraní API spravovaného API Management, směrování se řídí tímto vzorem:

Adresa URL požadavku klienta:
[API Management gateway URL] + [API URL suffix] + [Operation endpoint]

API Management požadavek předá back-endové službě pomocí tohoto vzoru:

Adresa URL back-endové služby:
[Web service URL] + [Operation endpoint]

Poznámka:

Koncový bod Operation musí být v definici rozhraní API API Management i back-endové službě stejný, aby směrování fungovalo správně. Kvůli neshodě koncových bodů operace dojde k chybám 404 nebo jiným chybám směrování.

Následující tabulka popisuje každý parametr směrování v kontextu příkladu rozhraní API Petstore použitého v tomto kurzu:

Parameter Popis Příklad (Rozhraní API Petstore)
adresa URL brány API Management Základní adresa URL vaší instance API Management https://apim-hello-world.azure-api.net
Přípona adresy URL rozhraní API Jedinečná přípona, která identifikuje vaše rozhraní API v API Management (nakonfigurované během vytváření rozhraní API) petstore
Adresa URL webové služby Základní adresa URL back-endové služby odvozená ze specifikace OpenAPI https://petstore3.swagger.io/api/v3
Koncový bod operace Cesta ke konkrétnímu koncovému bodu operace (odvozená ze specifikace rozhraní API) /pet/findByStatus

Příklad: Vyhledání domácích zvířat podle stavu

Použití rozhraní API Petstore importovaného v tomto kurzu:

  • Klient volá API Management:
    https://apim-hello-world.azure-api.net/petstore/pet/findByStatus?status=pending

    • adresa URL brány API Management: https://apim-hello-world.azure-api.net
    • Přípona adresy URL rozhraní API: petstore
    • Koncový bod operace: /pet/findByStatus

  • API Management směrování do back-endu:
    https://petstore3.swagger.io/api/v3/pet/findByStatus?status=pending

    • Adresa URL webové služby: https://petstore3.swagger.io/api/v3
    • Koncový bod operace: /pet/findByStatus (stejné jako v definici API Management)

Další krok

V dalším kurzu se dozvíte, jak vytvořit a publikovat produkt:

Vytvoření a publikování produktu

  • Last updated on