Co je Azure API Center?
Azure API Center je nová služba v Azure, která nabízí strukturované a centralizované úložiště všech rozhraní API vaší organizace, které umožňuje jednotné sledování, zjišťování, opakované použití a zásady správného řízení. API Center je zabezpečené řešení, které konsoliduje a uspořádá všechna vaše rozhraní API bez ohledu na jejich typ, fázi životního cyklu vývoje nebo umístění nasazení pro modul runtime rozhraní API společně s veškerými metadaty nebo informacemi souvisejícími s rozhraním API.
Výhody centra rozhraní API
| Problém zákazníka | Výhody centra rozhraní API |
|---|---|
| Špatná zjistitelnost a opakované použití rozhraní API | Snadné zjišťování a spotřeba rozhraní API Správci rozhraní API můžou zobrazit kompletní inventář všech rozhraní API na webu Azure Portal. Uživatelé rozhraní API můžou pomocí webového portálu API Center zjišťovat a využívat rozhraní API nebo pomocí rozšíření API Center pro Visual Studio Code vytvářet, zjišťovat a využívat rozhraní API. |
| Stínová, ungoverovaná rozhraní API | Centralizovaný inventář rozhraní API. Api Center umožňuje organizacím vytvářet centrální úložiště rozhraní API od různých týmů a oddělení, která fungují jako konsolidovaný zdroj pravdy a důvěryhodnosti pro všechna rozhraní API. |
| Potenciální bezpečnostní hrozby | Usnadnění zásad správného řízení rozhraní API Díky rozhraním API konsolidovaným v jednom umístění se pro týmy platformy API zjednoduší řízení těchto rozhraní API tak, aby vynucovaly zásady zabezpečení organizace. |
| Nekonzistentní návrh rozhraní API | Kontroly souladu s automatizovaným návrhem rozhraní API Api Center umožňuje správcům vynucovat standardy návrhu napříč všemi rozhraními API a implementovat lintující pracovní postup, který kontroluje rozhraní API proti definovanému průvodci stylem a generuje sestavu dodržování předpisů rozhraní API přístupnou ve vašem centru API. |
Role ekosystému rozhraní API a odpovědnosti
Ekosystém rozhraní API organizace se často skládá z různých rolí s různorodými zodpovědnostmi, které jsou nedílnou součástí úspěšné operace. Pojďme se podrobněji podívat na některé role.
Producenti rozhraní API – Můžou to být jednotliví vývojáři nebo týmy, jejichž hlavní odpovědnost patří:
- Konsolidace specifikací a požadavků systému
- Návrh architektury rozhraní API, která odpovídá definovaným cílům
- Vývoj, zabezpečení a publikování rozhraní API
- Testování a zajištění, aby rozhraní API splňovala požadavky na funkčnost i výkon
- Dokumentace rozhraní API
- Operace údržby rozhraní API, které zahrnují správu verzí a aktualizací
Producenti rozhraní API se snaží zajistit, aby dodržovali osvědčené postupy, zásady zabezpečení a dodržování předpisů a standardy rozhraní API organizace pro zajištění konzistence. Musí také zajistit, aby nezdvojily úsilí předchozích nebo jiných týmů v organizaci.
Příjemci rozhraní API – Mohou to být interní nebo externí uživatelé rozhraní API, kteří:
- Využívání privátních rozhraní API v interních obchodních pracovních postupech a službách (interní spotřebitelé)
- Použití omezených koncových bodů rozhraní API k integraci do strategických obchodních partnerství (spotřebitelé partnerů)
- Využívání veřejně dostupných rozhraní API k vytváření externích systémů, které používají služby poskytované organizací (spotřebitelé třetích stran)
Uživatelé rozhraní API potřebují zajistit, aby rychle objevili nejvhodnější rozhraní API pro své úlohy, aby se vyhnuli plýtvání cennými vývojářskými prostředky a úsilím o duplikování. Aby toho dosáhli, je důležité, aby získali kvalitní a snadno použitelnou dokumentaci k ověření rozhraní API, která řeší jejich příslušné potřeby, a aby se mohli bezproblémově integrovat do svých aplikací.
Tým platformy API – Technici platformy API dbají na vytváření a udržování škálovatelných, zabezpečených a vysoce výkonných architektur rozhraní API pro svou organizaci. Mezi jejich úkoly patří:
- Návrh a vývoj architektury rozhraní API
- Vytvoření a vynucení osvědčených postupů rozhraní API a standardů návrhu v celé organizaci
- Vynucování monitorování, analýzy a generování sestav pro generování přehledů s možností akce
- Implementace a správa zabezpečení rozhraní API prostřednictvím ověřovacích, autorizačních a šifrovacích protokolů
- Usnadnění spolupráce a zpětné vazby mezi správci produktů, výrobci rozhraní API a spotřebiteli za účelem sladění strategií rozhraní API
- Pomoc s integrací rozhraní API a řešením potíží interně i externě
Technici platformy API ve společnosti Contoso spolupracují na zavedení snadno použitelné strategie, která organizaci zabrání v rozrůstávání rozhraní API.
Jak funguje Centrum rozhraní API
Technici platformy API v organizaci potřebují rychlý a snadný způsob konfigurace centralizovaného úložiště všech jejich rozhraní API (interních i externích) spolu s dalšími metadaty, jako jsou verze rozhraní API, definice a další. Pomocí služby API Center můžete vytvořit katalog rozhraní API hostovaných a spravovaných v různých řešeních API Management a spravovat je v různých návrhech, vývoji, testování a produkčních životních cyklech.
Možnosti služby Azure API Center
Inventář rozhraní API
Základem služby API Center je vytvoření kompletního a aktuálního inventáře všech rozhraní API vytvořených a používaných v celé organizaci. Tento inventář je klíčem k povolení zásad správného řízení, zjišťování a spotřeby rozhraní API ve velkém měřítku.
Pomocí služby API Center můžete do inventáře přidávat rozhraní API bez ohledu na:
- Technologie a jazyk rozhraní API: ASP.NET základní webové rozhraní API, Express, FastAPI, bezserverové rozhraní API atd.
- Typ rozhraní API: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook atd.
- Runtime prostředí: Cluster Kubernetes, Webová aplikace, API Management, Apigee API Management, Azure Functions atd.
Zásady správného řízení rozhraní API
Teď, když máme kompletní inventář rozhraní API, musíme se podívat, jak můžeme zajistit, aby tato rozhraní API byla konzistentní, standardizovaná, použitelná a zabezpečená. Zásady správného řízení rozhraní API se definují jako postup definování a uplatňování standardů, zásad a procesů ve velkém měřítku napříč všemi rozhraními API organizace.
Tato funkce ve službě API Center zjednodušuje sledování rozhraní API pomocí metadat, jako jsou verze, vlastníci, životní cyklus a sledování procesů, jako jsou kontroly dodržování předpisů, detekce zásadních změn atd.
Api Center také nabízí nástroje týkající se zásad správného řízení návrhu rozhraní API, které podporují lintování, implementované pomocí linteru Spectral JSON/ YAML, které zajišťuje, že registrovaná rozhraní API odpovídají pravidlům stylu organizace a poskytují analytické funkce pro vaše rozhraní API. Povolení této možnosti pro vaši organizaci pomáhá včas odhalit chyby a nekonzistence generováním sestavy dodržování předpisů, která se dá zobrazit v Centru rozhraní API.
Úsilí o platformu API je nejúspěšnější, když mají vývojářský nákup. Rozšíření API Center pro Visual Studio Code poskytuje možnosti zásad správného řízení rozhraní API s posunem doleva pro detekci zásadních změn a zásady správného řízení návrhu rozhraní API, aby se zajistilo, že rozhraní API jsou vytvořená správným způsobem poprvé.
Zjišťování a spotřeba rozhraní API
Api Center zjednodušuje celý životní cyklus vývoje rozhraní API a vylepšuje vývojářské prostředí integrací s oblíbenými vývojářskými nástroji, jako je Visual Studio Code. Rozšíření API Center poskytuje uživatelům rozhraní API prostředí ke zjišťování, vyzkoušení a využívání rozhraní API přímo v editoru Visual Studio Code v kontextu toho, jak už fungují. Další funkcí služby API Center je tradiční webový portál API Center, který umožňuje uživatelům rozhraní API snadno procházet dokumentaci, zjišťovat, přistupovat k rozhraním API a využívat rozhraní API z katalogu rozhraní API.
V další lekci se dozvíte, jak můžete vytvořit a spravovat inventář rozhraní API pomocí služby API Center prostřednictvím webu Azure Portal, místně pomocí Azure CLI nebo VS Code pomocí rozšíření API Center.