Rozhraní FABRIC API pro zobrazení schématu GraphQL a Průzkumník schématu
Schéma GraphQL, které je založené na jazyce SDL (GraphQL Schema Definition Language), definuje formát dat vystavených v rozhraní API. Jedná se o abstrakční vrstvu, která uživatelům poskytuje flexibilitu při skrývání podrobností implementace back-endu. Schéma je založeno na kolekci typů objektů, které obsahují pole.
Zobrazení schématu
K zobrazení schématu se dostanete tak , že v levém dolním rohu obrazovky Vývoj dat vyberete Schéma . Zobrazení zobrazuje textovou verzi SDL GraphQL s vygenerovanými typy, poli a operacemi.
Následující obrázek je příkladem zobrazení schématu, včetně rozsáhlého seznamu objektů dostupných v tomto schématu.
Poznámka:
Zobrazení schématu je jen pro čtení. Objekty můžete upravovat pouze v Průzkumníku schémat.
Průzkumník schématu
Průzkumník schématu se nachází v podokně vlevo a je k dispozici také při použití editoru v zobrazení dotazu. Průzkumník umožňuje uživatelům rychle vizualizovat dostupné typy a pole a také dotazy a mutované definice v rozhraní API.
Všechny typy GraphQL, které jsou k dispozici z objektů, které zvolíte při připojení ke zdroji dat, se zobrazí v seznamu Průzkumníka schématu. Typy se zobrazí pod názvem zdroje dat, ze kterého byly odvozeny. Na následujícím obrázku vidíte typ SalesOrderDetail odvozený z tabulky SalesOrderDetail v koncovém bodu analýzy SQL AdventureWorks.
Kromě typů rozhraní API fabric pro GraphQL automaticky generuje dotazy a mutaci pro všechny nové objekty, které se rozhodnete zveřejnit.
V našem příkladu AdventureWorks se rozbalením seznamu dotazů zobrazí automaticky vygenerované dotazy pro zdroj dat.
Chcete-li zobrazit mutaci automaticky vygenerované rozhraním API, rozbalte uzel mutací ve stromu Průzkumníka schématu.
Úprava objektů pomocí Průzkumníka schématu
Průzkumníka schémat můžete použít k úpravě objektů po jejich vytvoření rozhraní API za vás. V následujícím příkladu vybereme tři tečky vedle typu SalesOrderDetail odvozeného z naší databáze AdventureWorks :
Pro typy jsou k dispozici následující možnosti:
- Schéma aktualizace – Umožňuje aktualizovat schéma novými objekty ze zdroje dat.
- Přejmenovat – změní název objektu. POZNÁMKA: Tato změna má vliv pouze na schéma rozhraní API a nemá žádný vliv na původní objekt zdroje dat, ze kterého byl odvozen.
- Odebrat ze schématu – Efektivně odstraní objekt ze schématu GraphQL, takže na něj už nepůjde odkazovat.
- Správa relací – přejdete do prostředí správy vztahů. Další informace najdete v tématu Správa relací v rozhraní Fabric API pro GraphQL.
- Vlastnosti – zobrazuje další informace o objektu.
Povolení a zakázání dotazů a mutací
Funkce povolení/zakázání dotazů a mutací poskytuje správcům a vývojářům podrobnou kontrolu nad přístupem a využití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.
Dotazy a mutací v Průzkumníku schématu mají dvě další možnosti:
- Zákaz – Zabrání všem požadavkům v provádění dotazu nebo mutaci. Při pokusu o spuštění se vrátí chyba. Jakmile je dotaz nebo mutaci zakázána, dojde k opětovnému načtení schématu a dotaz nebo mutaci se v Průzkumníku schémat zobrazí šedě.
- Povolení – Opětovné povolení dříve zakázaného dotazu nebo mutaci Spuštění položky je okamžitě k dispozici po operaci opětovného načtení schématu , která probíhá po výběru možnosti Povolit .
Upozorňujeme, že dotazy nebo mutované automaticky generované z uložených procedur je možné odstranit pouze. Po odstranění je možné je znovu přidat pomocí možností Získat data nebo Aktualizovat schéma .