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

Schéma GraphQL založené na jazyce SDL (GraphQL Schema Definition Language) definuje formát dat vystavených v rozhraní API. Poskytuje uživatelům flexibilitu při skrývání podrobností implementace back-endu. Schéma používá 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 . Toto zobrazení zobrazuje textovou verzi knihovny GraphQL SDL s vygenerovanými typy, poli a operacemi.

Následující obrázek ukazuje příklad zobrazení schématu, včetně seznamu objektů dostupných v tomto schématu.

Poznámka:

Zobrazení schématu je jen pro čtení. Upravte objekty pouze v Průzkumníku schématu.

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 seznamu Průzkumníka schématu se zobrazí všechny typy GraphQL dostupné z objektů, které zvolíte při připojování ke zdroji dat. Typy se zobrazí pod názvem zdroje dat, ze kterého byly odvozeny. Následující obrázek ukazuje 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 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.

Rozbalte uzel mutací ve stromu Průzkumníka schémat, abyste viděli mutace automaticky vygenerované rozhraním API.

Ú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. Tato změna má vliv pouze na schéma rozhraní API a nemá vliv na původní objekt zdroje dat, ze kterého je odvozen.

• Odebrat ze schématu – Odstraní objekt ze schématu GraphQL, takže na něj už nemůžete odkazovat.

• Správa relací – Otevře prostředí správy relací. 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í 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.

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.

Dotazy nebo muty, které se automaticky vygenerovaly z uložených procedur, je možné odstranit pouze. Po odstranění je možné je přečíst pomocí možností získat data nebo aktualizovat schéma .

Související obsah

• Zjistěte více o Fabric API integrovaném do editoru GraphQL.