Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Prozkoumejte klíčové koncepty služby Azure API Center, které umožňují sledovat rozhraní API v centralizované lokalitě pro zjišťování, opakované použití a zásady správného řízení.
Datový model
Mezi hlavní entity v konfiguraci Azure API Center patří vaše rozhraní API a jejich verze, definice a nasazení. Možná spouštěcí prostředí pro každé API a popisná metadata doplňují konfiguraci.
Následující diagram znázorňuje hlavní entity a jejich vzájemné vztahy.
API
Logická entita nejvyšší úrovně ve službě Azure API Center představuje jakékoli reálné rozhraní API, které chcete sledovat. Centrum rozhraní API může zahrnovat rozhraní API libovolného typu, včetně rozhraní REST, GraphQL, gRPC, SOAP, WebSocket a Webhook.
Rozhraní API v inventáři můžete spravovat pomocí libovolného řešení API Management. Můžete například použít Azure API Management, Apigee API Management, Kong Konnect, MuleSoft API Management nebo jinou platformu. Rozhraní API reprezentované ve službě Azure API Center může být také nespravované.
Správci programů rozhraní API nebo správci IT můžou vytvářet a spravovat inventář rozhraní API ve službě Azure API Center. Azure API Center také obsahuje funkce pro vývojáře rozhraní API k registraci definic rozhraní API přímo z jejich vývojových prostředí, jako jsou kanály Visual Studio Code nebo kanály CI/CD.
Verze rozhraní API
Správa verzí rozhraní API je postup správy změn rozhraní API a zajištění provádění změn bez narušení klientů. Rozhraní API může mít více verzí napříč fázemi životního cyklu, z nichž každý je v souladu s konkrétními změnami rozhraní API. Některé verze můžou představovat hlavní nebo zásadní změny, zatímco jiné přidávají menší vylepšení. Verze rozhraní API může být v jakékoli fázi životního cyklu od návrhu až po verzi Preview, produkční nebo zastaralá.
Definice rozhraní API
Pro každou verzi rozhraní API by měla existovat alespoň jedna definice, například definice OpenAPI pro rozhraní REST API. Azure API Center umožňuje libovolný definiční soubor rozhraní API formátovaný jako text (YAML, JSON, Markdown atd.). Mimo jiné můžete nahrát definice OpenAPI, gRPC, GraphQL, AsyncAPI, WSDL a WADL.
Azure API Center poskytuje funkce pro lintování, které umožňují analyzovat definice rozhraní API pro kvalitu a dodržování předpisů v organizačních standardech.
Prostředí
Prostředí představuje umístění, kde je možné nasadit modul runtime rozhraní API, jako je služba Azure API Management nebo služba Apigee API Management. Můžete také nasadit do výpočetní služby, jako je cluster Kubernetes, webová aplikace nebo aplikace Azure Functions. Každé prostředí je v souladu s fází životního cyklu, jako je vývoj, testování, příprava nebo produkce. Prostředí může také obsahovat informace o vývojářském portálu nebo rozhraní pro správu.
Poznámka:
Azure API Center můžete použít ke sledování libovolného běhového prostředí API bez ohledu na to, zda jsou hostovaná v infrastruktuře Azure. Tato prostředí nejsou stejná jako prostředí nasazení Azure.
Nasazení
Nasazení je umístění (adresa), kde mají uživatelé přístup k rozhraní API. Rozhraní API může mít více nasazení, například různá přípravná prostředí nebo oblasti. Například rozhraní API může mít jedno nasazení v interním přípravném prostředí a sekundu v produkčním prostředí. Každé nasazení je přidružené ke konkrétní definici rozhraní API.
Metadata
Ve službě Azure API Center uspořádejte svá rozhraní API, nasazení a další entity nastavením hodnot metadat. Metadata jsou užitečná pro vyhledávání a filtrování a vynucování standardů zásad správného řízení. Centrum rozhraní API poskytuje několik běžných předdefinovaných vlastností metadat, jako API type a lifecycle stage. Vlastník centra rozhraní API může rozšířit předdefinovaná metadata definováním vlastních metadat ve schématu metadat za účelem uspořádání jejich rozhraní API, nasazení a prostředí. Vytvořte například vlastnost metadat, API approver která identifikuje osobu odpovědnou za schvalování rozhraní API pro použití.
Azure API Center podporuje vlastní metadata pole typů, logické hodnoty, číslo, objekt, předdefinované volby a řetězec.
Schéma metadat Centra rozhraní Azure API je kompatibilní se specifikacemi schématu JSON a YAML, které umožňují ověřování schématu v nástrojích pro vývojáře a automatizovaných kanálech.