Sdílet prostřednictvím

Azure API Center – klíčové koncepty

  • Článek

Tento článek vysvětluje klíčové koncepty azure API Center. Azure API Center umožňuje sledování rozhraní API v centralizované lokalitě pro zjišťování, opakované použití a zásady správného řízení.

Datový model

Následující diagram znázorňuje hlavní entity ve službě Azure API Center a jejich vzájemné vztahy. Další informace o těchto entitách a souvisejících konceptech najdete v následujících částech.

Diagram znázorňující klíčové funkce datového modelu v Azure API Center

rozhraní 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 může spravovat jakékoli řešení API Management (například Azure API Management nebo řešení od jiných poskytovatelů) nebo nespravované.

Inventarizace rozhraní API ve službě Azure API Center je navržená tak, aby byla vytvořena a spravována správci programů rozhraní API nebo správci IT.

Verze rozhraní API

Správa verzí rozhraní API je postup správy změn rozhraní API a zajištění toho, aby se tyto změny provedly 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

Každá verze rozhraní API by měla být v ideálním případě definována alespoň jednou definicí, například definicí 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.

Prostředí

Prostředí představuje umístění, kde je možné nasadit modul runtime rozhraní API, například službu Azure API Management, službu Apigee API Management nebo výpočetní službu, jako je cluster Kubernetes, webová aplikace nebo funkce 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 obsahovat také informace o vývojářském portálu nebo rozhraní pro správu.

Poznámka:

Pomocí Azure API Center můžete sledovat jakékoli prostředí modulu runtime rozhraní API bez ohledu na to, jestli 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, které je možné použít k vyhledávání a filtrování a k vynucování standardů zásad správného řízení. Centrum rozhraní API poskytuje několik běžných předdefinovaných vlastností metadat, jako je typ rozhraní API a fáze životního cyklu. 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 schvalovatele rozhraní API, 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.

Související obsah