Import a publikování rozhraní API

  • 5 min

Pokud chcete rozhraní API zpřístupnit pomocí brány rozhraní API, musíte rozhraní API importovat a publikovat.

V příkladu obuvnické společnosti chce společnost NorthWind Shoes povolit vybraným partnerům dotazovat se na stav inventáře a skladových zásob.

Tady se dozvíte, jak importovat rozhraní API do služby Azure API Management a jak zpřístupnit rozhraní API klientům.

API

Rozhraní API je standardizovaný způsob, jakým organizace zveřejňují konkrétní data potenciálním vývojářům nebo partnerům. V předchozím cvičení jste například vytvořili rozhraní API pro sdílení informací o produktech a inventáři.

Zpřístupnění rozhraní API začíná importem rozhraní API do API Managementu. Pak můžete:

  • Použít nástroje pro vizualizaci v bráně rozhraní API k otestování vašeho rozhraní API.
  • Spravovat přístup k rozhraním API pomocí zásad.

Rozhraní API

Existují různá rozhraní a standardy API. API Management nabízí několik možností pro import rozhraní API.

Typ Detaily
HTTP Rozhraní HTTP API můžete importovat s prázdnou definicí rozhraní API. Všechny požadované parametry pak zadáte ručně.
WebSocket Nastavte průchod do back-endové služby WebSocket.
GraphQL Nastavte průchod do back-endové služby GraphQL nebo naimportujte schéma GraphQL a vytvořte syntetické rozhraní GraphQL API s vlastními překladači polí.
OpenAPI OpenAPI je specifikace, která dokumentuje všechny koncové body a operace pro rozhraní RESTful API a všechny vstupní a výstupní parametry. OpenAPI se původně označovalo jako Swagger.
WADL Web Application Description Language je popis XML webových služeb založených na protokolu HTTP. Je to jednodušší formát a jednodušší než WSDL.
WSDL Web Service Description Language je popis XML jakékoli síťové služby, ne jen HTTP.

Můžete také importovat rozhraní API z několika back-endových prostředků Azure.

Typ Detaily
Aplikace logiky Aplikace logiky umožňují orchestrovat a automatizovat pracovní postupy a integrace s různými zdroji dat.
App Service Rozhraní API hostované ve službě App Service v Azure
Function App Bezserverový kód, který je možné volat pomocí triggerů.
Kontejnerová aplikace Bezserverové kontejnery pro mikroslužby

Import rozhraní API

Existuje několik způsobů, jak importovat rozhraní API do Azure API Managementu.

Na webu Azure Portal vyberte Rozhraní API a potom + Přidat rozhraní API. Začněte výběrem typu rozhraní API, který chcete importovat.

Screenshot of Azure portal showing API Management service with the APIs section highlighted and selected.

Potom zadejte odkaz na specifikaci vašeho rozhraní API, například adresu URL nebo soubor, a název rozhraní API. Tady je příklad importu OpenAPI.

Screenshot of create from OpenAPI specification import settings with OpenAPI specification and display name fields highlighted.

Azure Portal není nejúčinnějším nástrojem pro import a konfiguraci velkého počtu rozhraní API. Při vertikálním navýšení kapacity služby API Management potřebujete další nástroje, jako jsou Azure CLI, Azure Resource Manager nebo šablony Bicep nebo Azure PowerShell. Můžete například použít rutiny Azure PowerShellu pro nasazování bran rozhraní API, definování a konfiguraci produktů, import rozhraní API a správu uživatelů a předplatných.

Vizualizace

Bránu rozhraní API můžete použít jako způsob vizualizace toho, jak se zpracovávají data prostřednictvím importovaných rozhraní API. Pomocí rozhraní API můžete pracovat s datovými sadami a předávat parametry.

Pokud jste správce, můžete vizualizovat rozhraní API na webu Azure Portal.

Screenshot of Azure portal API configuration showing a highlighted GET request test on an imported API.

Zásady

Zásady poskytují výkonné funkce pro změnu chování rozhraní API prostřednictvím konfigurace. Představují kolekci příkazů, které se postupně provádí na základě požadavku nebo odezvy z rozhraní API.

Mezi oblíbené konfigurace patří:

  • Převod z formátu XML do formátu JSON
  • Omezení frekvence volání za účelem snížení počtu příchozích volání
  • Nastavení příchozích a odchozích hlaviček

Web Azure Portal používáte k použití různých zásad na rozhraní API. Zásady můžete zobrazit na kartě Návrh.

Screenshot of Azure portal showing API configuration for all operations with base policies highlighted for inbound, outbound, and backend sections.

K přidání nových zásad můžete použít také kartu Návrh .

Screenshot of Azure portal showing inbound policy options for API configuration.

Produkt

Produkt je kolekce rozhraní API. Rozhraní API můžete přiřadit více produktům. Můžete třeba chtít, aby jeden produkt – NorthWindShoesPartners zveřejnil dvě rozhraní API pro partnery:

Produkt NorthWindShoesPartners
API 1 Inventář
API 2 Plánování

Pro dodavatele můžete chtít zveřejnit pouze jedno rozhraní API:

Produkt NorthWindShoesSuppliers
API 1 Inventář
API 2

Zásady můžete přiřadit tak, aby vaše produkty mohly mít různá pravidla přístupu, kvóty využití a podmínky použití. Pokud chcete, aby vaši partneři a dodavatelé měli jiná přístupová práva k rozhraní API Inventář, přiřaďte rozhraní API dvěma různým produktům.

K přidružení rozhraní API a produktu použijte web Azure Portal.

Screenshot of Azure portal showing API Management with products section highlighted.

Pro všechny cenové úrovně kromě Consumption existují dva výchozí produkty: Starter a Unlimited. Neomezený produkt je navržen pro správu rozhraní API v produkci, protože nemá žádná omezení týkající se počtu připojených rozhraní API. Můžete vytvořit tolik nových produktů, kolik potřebujete. Počáteční produkt má limit pěti volání rozhraní API za minutu a maximálně 100 volání rozhraní API za týden.