Kurz: Import a publikování prvního rozhraní API
Tento kurz ukazuje, jak importovat back-endové rozhraní API specifikace OpenAPI ve formátu JSON do Azure API Management. Microsoft poskytuje back-endové rozhraní API použité v tomto příkladu a hostuje ho v Azure na https://conferenceapi.azurewebsites.net?format=json adrese .
Jakmile back-endové rozhraní API naimportujete do API Management, API Management API se stane průčelí pro back-endové rozhraní API. Průčelí si můžete přizpůsobit podle svých potřeb v API Management 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 API Management
- Testovat rozhraní API na portálu Azure Portal
Po importu můžete rozhraní API spravovat v Azure Portal.
Požadavky
Přejít k instanci služby API Management
V Azure Portal vyhledejte a vyberte API Management Services.
Na stránce API Management služby vyberte svou instanci API Management.
Import a publikování back-endového rozhraní API
Tato část ukazuje, jak importovat a publikovat back-endové rozhraní API specifikace OpenAPI.
V levém navigačním panelu vaší instance API Management rozhraní API.
Vyberte dlaždici OpenAPI.
V okně Create from OpenAPI specification (Vytvořit ze specifikace OpenAPI) vyberte Full (Úplné).
Zadejte hodnoty z následující tabulky. Pak vyberte Vytvořit a vytvořte své rozhraní API.
Hodnoty rozhraní API můžete nastavit při vytváření nebo později tak, že Nastavení kartu.
Nastavení Hodnota Popis Specifikace OpenAPI https: / /conferenceapi.azurewebsites.net?format=json Služba implementující rozhraní API. API Management požadavky na tuto adresu. Služba musí být hostovaná na veřejně přístupné internetové adrese. Zobrazovaný název Po zadání předchozí adresy URL služby API Management toto pole na základě formátu JSON. Název zobrazený na portálu pro vývojáře. Název Po zadání předchozí adresy URL služby API Management toto pole na základě formátu JSON. Jedinečný název rozhraní API. Popis Po zadání předchozí adresy URL služby API Management toto pole na základě formátu JSON. Volitelný popis rozhraní API. Schéma URL HTTPS Které protokoly mají přístup k rozhraní API. Přípona adresy URL rozhraní API Konference Přípona připojená k základní adrese URL pro API Management služby. API Management rozlišuje rozhraní API podle jejich přípony, takže přípona musí být pro každé rozhraní API daného vydavatele jedinečná. 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á API Management obsahuje dva ukázkové produkty: Starter a Unlimited. Rozhraní API publikujete tak, že v tomto příkladu přidružíte rozhraní API k produktu Unlimited.
Do produktu můžete zahrnout několik rozhraní API a nabídnout je vývojářům 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 k více produktům. Rozhraní API můžete k produktům přidat také později z Nastavení stránky.
Další informace o produktech najdete v tématu Vytvoření a publikování produktu.Brány Spravované Brány rozhraní API, které zpřístupňuje rozhraní API. Toto pole je k dispozici pouze ve službách developer a Premium vrstvě.
Spravovaná označuje bránu integrovanou do API Management a hostovanou Microsoftem v Azure. Brány v vlastním hostování jsou k dispozici pouze v úrovních služeb Premium a Developer. Můžete je nasadit místně nebo v jiných cloudech.
Pokud nejsou vybrané žádné brány, rozhraní API nebude dostupné a vaše požadavky rozhraní API nebudou úspěšné.Chcete vytvořit verzi tohoto rozhraní API? Výběr nebo zrušení výběru Další informace najdete v tématu Publikování několika verzí rozhraní API. Poznámka
Pokud chcete rozhraní API publikovat pro uživatele rozhraní API, musíte ho přidružit k produktu.
Vyberte Vytvořit.
Pokud máte problémy s importem definice rozhraní API, podívejte se na seznam známých problémů a omezení.
Testování nového rozhraní API v Azure Portal
Operace rozhraní API můžete volat přímo z Azure Portal, což poskytuje pohodlný způsob, jak zobrazit a otestovat operace.
V levém navigačním panelu vaší instance API Management rozhraní API Demo > Conference API.
Vyberte kartu Test a pak vyberte GetSpeakers. Na stránce se zobrazí parametry dotazu a hlavičky, pokud jsou k nějaké. Klíč Ocp-Apim-Subscription-Key se vyplní automaticky pro klíč předplatného přidružený k tomuto rozhraní API.
Vyberte Odeslat.
Back-end odpoví 200 OK a některá data.
Další kroky
V tomto kurzu jste se naučili:
- 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: