Rozhraní Fabric API pro zobrazení schématu GraphQL a průzkumník schématu

Rozhraní API fabric pro GraphQL automaticky vygeneruje schéma, které definuje strukturu vašeho rozhraní API na základě zdrojů dat, které připojíte. Schéma napsané v jazyce SDL (GraphQL Schema Definition Language) popisuje všechny dostupné typy, pole, dotazy a mutaci, které můžou klienti použít k interakci s vašimi daty.

Zobrazení schématu poskytuje jen pro čtení zobrazení celého schématu GraphQL, zatímco průzkumník schématu v levém podokně umožňuje procházet, kontrolovat a upravovat objekty zpřístupněné prostřednictvím vašeho rozhraní API. Tyto nástroje vám společně pomůžou porozumět struktuře rozhraní API a řídit, jaká data jsou přístupná klientům.

Kdo používá zobrazení schématu

Zobrazení schématu a průzkumník jsou cenné pro:

Datoví inženýři, kteří konfigurují objekty datového jezera a datového skladu Fabric k zveřejnění prostřednictvím GraphQL
Vývojáři aplikací objevující dostupné druhy dat služby Fabric, pole a vztahy před vytvářením dotazů
Přispěvatelé pracovních prostorů Fabric chápou a spravují strukturu přístupu k datům pro svůj pracovní prostor.
Vývojáři BI, kteří při vytváření vlastních analytických aplikací kontrolují datové vazby v systému Fabric

Pomocí zobrazení schématu můžete prozkoumat strukturu rozhraní API a průzkumníka schématu a upravit, které datové objekty jsou vystaveny.

Přístup ke schématu a prozkoumání schématu

K zobrazení schématu můžete přistupovat z editoru dotazů nebo přímo z položky rozhraní GraphQL API. Pokud chcete otevřít zobrazení schématu, vyberte Schéma v levém dolním rohu. Zobrazení schématu zobrazuje textovou verzi SDL, která je pouze pro čtení, s kompletními vygenerovanými typy, poli, dotazy a mutacemi.

Následující obrázek znázorňuje zobrazení schématu s podoknem Průzkumník schémat na levé straně:

Navigace v Průzkumníku schémat

Průzkumník schématu v levém podokně umožňuje procházet a kontrolovat všechny objekty v rozhraní API. Průzkumník je k dispozici v zobrazení schématu i v editoru dotazů, což usnadňuje prozkoumání struktury rozhraní API při psaní dotazů.

Rozbalte uzly v průzkumníku schémat a zobrazí se:

Typy: Typy GraphQL generované z tabulek a zobrazení zdroje dat
Dotazy: Automaticky generované operace čtení pro načítání dat
Mutace: Automaticky generované zápisové operace pro vytváření, aktualizaci a odstraňování dat (pouze sklad)

Types

Typy představují strukturu vašich dat a zobrazují se pod názvem zdroje dat, ze kterého byly generovány. Následující obrázek ukazuje typ SalesOrderDetail vygenerovaný z tabulky SalesOrderDetail v koncovém bodu analýzy SQL AdventureWorks :

Queries

Rozhraní API automaticky generuje dotazy pro načítání dat z objektů, které zveřejňujete. Rozbalením uzlu dotazů zobrazíte všechny dostupné operace čtení:

Mutace

Mutační operace jsou operace zápisu pro vytváření, aktualizaci a odstraňování dat. Rozbalte uzel mutací, abyste viděli všechny dostupné operace zápisu:

Poznámka:

Mutace se generují pouze pro zdroje dat datového skladu Fabric. SQL analytické endpointy (jezerní domy a zrcadlové databáze) jsou pouze pro čtení a podporují pouze dotazy. Pokud ve svém průzkumníku schémat nevidíte mutace, ověřte, že jste se připojili ke skladu.

Úprava objektů pomocí Průzkumníka schématu

Jakmile rozhraní API vygeneruje vaše počáteční schéma, můžete pomocí Průzkumníka schémat upřesnit, co je vystavené prostřednictvím vašeho rozhraní API. Průzkumník schématu poskytuje možnosti správy, které umožňují řídit strukturu rozhraní API beze změny podkladových zdrojů dat. Tyto nástroje jsou nezbytné pro údržbu čistého a dobře uspořádaného rozhraní API, které zpřístupňuje pouze data, která klienti potřebují.

Možnosti úprav accessu

Pokud chcete objekt upravit, vyberte tři tečky (...) vedle libovolného typu v Průzkumníku schématu. Následující příklad ukazuje nabídku úprav pro Typ SalesOrderDetail :

Dostupné možnosti úprav

Schéma aktualizace – Synchronizuje schéma GraphQL s nejnovější strukturou ze zdroje dat. Tuto možnost použijte, když jste do zdroje dat přidali nové tabulky, zobrazení nebo sloupce a chcete je zveřejnit prostřednictvím rozhraní API. Tato operace zjistí a přidá nové objekty při zachování stávající konfigurace.

Přejmenování – změní způsob zobrazení objektu v rozhraní GraphQL API. To je užitečné při vytváření intuitivnějších konvencí pojmenování rozhraní API nebo skrytí podrobností implementace od klientů. Můžete například přejmenovat tbl_SalesOrderDetail na jednoduše SalesOrderDetail. Přejmenování má vliv jenom na schéma rozhraní API a neupravuje podkladový objekt zdroje dat.

Odebrat ze schématu – Odebere objekt z rozhraní GraphQL API, aby byl pro klienty nedostupný. Tato možnost slouží ke skrytí citlivých dat, odebrání zastaralých objektů nebo zjednodušení povrchu rozhraní API. Data zůstávají ve vašem zdroji dat; Odebere se pouze expozice rozhraní API.

Správa relací – Otevře rozhraní pro správu relací, kde můžete definovat, jak se objekty vzájemně propojují. Relace umožňují vnořené dotazy a procházení grafů a umožnit klientům načíst související data v jediném požadavku. Další informace najdete v tématu Správa relací v rozhraní Fabric API pro GraphQL.

Vlastnosti – zobrazí podrobná metadata o objektu, včetně původního názvu, který se zobrazí ve zdroji dat, názvu typu GraphQL, vlastníka a umístění (název pracovního prostoru a zdroje dat). Pomocí tohoto postupu ověřte, jak se objekty mapují mezi zdrojem dat a rozhraním GraphQL API.

Povolení a zakázání dotazů a mutací

Funkce povolení nebo zakázání dotazů a mutací poskytuje správcům a vývojářům podrobnou kontrolu nad přístupem a používáním rozhraní API. Umožňuje selektivně aktivovat nebo deaktivovat konkrétní dotazy a muty v rámci schématu GraphQL. Díky tomu můžete dynamicky spravovat funkce rozhraní API, aniž byste museli upravovat kód nebo nasazovat změny.

Tuto funkci použijte pro scénáře, jako jsou:

Správa verzí rozhraní API: Zakázání zastaralých operací při přechodu klientů na nové verze
Časová období údržby: Během údržby dat dočasně zakažte operace zápisu (mutací)
Zabezpečení a dodržování předpisů: Omezení přístupu k citlivým operacím bez jejich odebrání ze schématu
Postupné zavádění: Povolte nové dotazy nebo mutace pro testování, než je zpřístupníte široké veřejnosti.

Dotazy a mutace v Průzkumníku schématu mají dvě další možnosti:

Zákaz: Zabrání spuštění jakýchkoli požadavků, které by vedly k dotazu nebo mutaci. Při pokusu o spuštění se vrátí chyba. Po zakázání dotazu nebo mutace se opětovně načte schéma a dotaz nebo mutace se v průzkumníku schématu zobrazí šedě.

Povolení: Umožňuje znovu povolit dříve zakázaný dotaz nebo mutaci. Dotaz nebo mutaci jsou k dispozici okamžitě po načtení schématu, ke kterému dojde, když vyberete možnost Povolit.