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

  • Článek

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

V tomto kurzu se dozvíte, jak importovat back-endové rozhraní API specifikace OpenAPI ve formátu JSON do služby Azure API Management. Microsoft poskytuje back-endové rozhraní API použité v tomto příkladu a hostuje ho v Azure na adrese https://conferenceapi.azurewebsites.net.

Po importu rozhraní API back-endu do služby API Management se rozhraní API služby API Management stane adaptační vrstvou pro rozhraní API back-endu. Adaptační vrstvu si můžete přizpůsobit svým potřebám ve službě API Management bez nutnosti zasahovat do rozhraní API back-endu. Další informace najdete v tématu Transformace a ochrana vašeho rozhraní API.

V tomto kurzu se naučíte:

  • Import rozhraní API do služby API Management
  • Testovat rozhraní API na portálu Azure Portal

Po importu můžete rozhraní API spravovat na webu Azure Portal.

Snímek obrazovky s novým rozhraním API ve službě API Management na portálu

Požadavky

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 a publikování back-endového rozhraní API

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

  1. V levém navigačním panelu instance služby API Management vyberte rozhraní API.

  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://conferenceapi.azurewebsites.net?format=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í ve službě API Management importovat požadované parametry dotazu ve specifikaci jako parametry šablony.
    Zobrazované jméno Jakmile zadáte adresu URL specifikace OpenAPI, služba API Management toto pole vyplní na základě kódu JSON. Název zobrazený na portálu pro vývojáře
    Název Jakmile zadáte adresu URL specifikace OpenAPI, služba API Management toto pole vyplní na základě kódu JSON. Jedinečný název rozhraní API.
    Popis Jakmile zadáte adresu URL specifikace OpenAPI, služba API Management toto pole vyplní na základě kódu JSON. Volitelný popis rozhraní API.
    Schéma URL HTTPS Které protokoly mají přístup k rozhraní API.
    Přípona adresy URL rozhraní API conference Přípona připojená k základní adrese URL služby API Management. Služba API Management rozlišuje rozhraní API podle jejich přípony, takže přípona musí být jedinečná pro každé rozhraní API daného vydavatele.
    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 Každá instance služby API Management má dva ukázkové produkty: Starter a Unlimited. Rozhraní API publikujete přidružením rozhraní API k produktu , který je v tomto příkladu neomezený .

    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 z Nastavení stránky.

    Další informace oproduktch
    Brány Spravované Brány rozhraní API, které zpřístupňují rozhraní API. Toto pole je k dispozici pouze ve službách úrovně Developer a Premium .

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

    Pokud nejsou vybrány žádné brány, rozhraní API nebude k dispozici a vaše požadavky rozhraní API nebudou úspěšné.
    Chcete toto rozhraní API ve verzi? Výběr nebo zrušení výběru Další informace najdete v tématu Publikování více verzí rozhraní API.

    Poznámka:

    Pokud chcete rozhraní API publikovat pro uživatele rozhraní API, musíte ho přidružit k produktu.

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

Pokud máte problémy s importem definice rozhraní API, prohlédněte si seznam známých problémů a omezení.

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

Operace rozhraní API můžete volat přímo z webu Azure Portal, což poskytuje pohodlný způsob zobrazení a testování operací. Ve výchozím nastavení se v testovací konzole portálu volají rozhraní API pomocí klíče z integrovaného předplatného pro přístup. Volání rozhraní API můžete testovat také pomocí klíče předplatného omezeného na produkt.

  1. V levém navigačním panelu vaší instance služby API Management vyberte rozhraní API>Demo Conference API.

  2. Vyberte kartu Test a pak vyberte GetSpeakers. Na stránce se zobrazují parametry dotazu a hlavičky( pokud existuje).

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

  3. Vyberte Odeslat.

    Snímek obrazovky s testováním rozhraní API na webu Azure Portal

    Back-end reaguje na 200 OK a některá data.

Další kroky

V tomto kurzu jste se naučili, jak:

  • Importovat vaše první rozhraní API
  • Testovat rozhraní API na portálu Azure Portal

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

Vytvoření a publikování produktu