Zdieľať cez

Rozhranie API služby Fabric pre zobrazenie schémy GraphQL a prieskumníka schém

  • Článok

Schéma GraphQL, ktorá je založená na jazyku definícií schémy GraphQL (SDL), definuje formát údajov zverejnených v rozhraní API. Je to abstraktná vrstva, ktorá poskytuje flexibilitu spotrebiteľom a zároveň skrýva koncové podrobnosti implementácie. Schéma je založená na kolekcii typov objektov, ktoré obsahujú polia.

Zobrazenie schémy

Prístup k zobrazeniu schémy získate tak , že vyberiete položku Schéma v ľavom dolnom rohu obrazovky Vývoja údajov. Zobrazenie zobrazuje textovú verziu SDL GraphQL s vygenerovanými typmi, poľami a operáciami.

Nasledujúci obrázok je príkladom zobrazenia schémy vrátane rozsiahleho zoznamu objektov, ktoré sú k dispozícii v tejto schéme.

Poznámka

Zobrazenie schémy je určené iba na čítanie. Objekty môžete upravovať iba v prieskumníkovi schém.

Snímka obrazovky zobrazenia schémy rozhrania API, ktorá obsahuje prieskumníka schém na ľavej table.

Prieskumník schém

Prieskumník schémy sa nachádza na table na ľavej strane a je k dispozícii aj pri používaní editora v zobrazení dotazu. Prieskumník umožňuje používateľom rýchlo vizualizovať dostupné typy a polia, ako aj dotazy a mutácie definované v rozhraní API.

Všetky typy GraphQL, ktoré sú k dispozícii z objektov, ktoré si vyberiete pri pripojení k zdroju údajov, sa zobrazia v zozname Prieskumník schém. Typy sa zobrazia pod názvom zdroja údajov, z ktorého boli odvodené. Na nasledujúcom obrázku vidíte typ entity SalesOrderDetail odvodený z tabuľky SalesOrderDetail v koncovom bode analýzy ADVENTUREWorks SQL.

Snímka obrazovky tably Prieskumník schém, ktorá zobrazuje rozbalený zoznam typov dostupných v príklade zdroja údajov s názvom SalesOrderDetail.

Okrem typov, Fabric API pre GraphQL automaticky generuje dotazy a mutácie pre všetky nové objekty, ktoré sa rozhodnete sprístupniť.

V našom príklade s databázou AdventureWorks sa pri rozbalení zoznamu dotazov zobrazujú automaticky generované dotazy pre zdroj údajov.

Snímka obrazovky tably Prieskumník schémy zobrazujúca rozbalený zoznam automaticky generovaných dotazov.

Ak chcete vidieť mutácie automaticky generované API, rozšíriť mutácie uzol v strome prieskumníka schémy.

Snímka obrazovky tably Prieskumník schémy zobrazujúca rozšírený zoznam automaticky generovaných mutácií.

Úprava objektov pomocou prieskumníka schémy

Na úpravu objektov môžete použiť prieskumníka schém po tom, ako ich rozhranie API vytvorí za vás. V nasledujúcom príklade vyberieme tri bodky vedľa typu SalesOrderDetail odvodeného z našej databázy AdventureWorks :

Snímka obrazovky prieskumníka schémy s vybratými tromi bodkami zobrazujúca dostupné možnosti ponuky.

Pre typy sú k dispozícii nasledujúce možnosti:

  • Aktualizácia schémy – umožňuje aktualizovať schému novými objektmi zo zdroja údajov.
  • Premenovať – zmení názov objektu. POZNÁMKA: Táto zmena má vplyv len na schému rozhrania API a nemá žiadny vplyv na pôvodný objekt zdroja údajov, z ktorého bol odvodený.
  • Odstrániť zo schémy – efektívne odstráni objekt zo schémy GraphQL, aby ste naň už nemohli odkazovať.
  • Spravovanie vzťahov – prejdete na prostredie správy vzťahov. Ďalšie informácie nájdete v téme Spravovanie vzťahov v rozhraní API služby Fabric pre GraphQL.
  • Vlastnosti – zobrazuje ďalšie informácie o objekte.

Povolenie a zakázanie dotazov a mutácií

Funkcia enable/disable pre dotazy a mutácie poskytuje správcom a vývojárom podrobnú kontrolu nad prístupom a používaním rozhrania API. Umožňuje selektívnu aktiváciu alebo deaktivovanie konkrétnych dotazov a mutácií v rámci schémy GraphQL. To vám umožňuje dynamicky spravovať možnosti rozhrania API bez toho, aby ste upravili kód alebo nasadili zmeny.

Dotazy a mutácie v prieskumníkovi schémy majú dve ďalšie možnosti:

  • Disable – zabraňuje vykonaniu dotazu alebo mutácie v žiadostiach. Pri pokuse o vykonanie sa vráti chyba. Akonáhle dotaz alebo mutácie je zakázaná, schéma reload nastane, a dotaz alebo mutácie sa zdá sivé v schéme prieskumníka.

Snímka obrazovky znázorňujúca možnosť zakázania dotazu alebo mutácie zobrazenú v prieskumníkovi schém.

  • Enable – znova povoľte predtým zakázanú mutáciu alebo dotaz. Spustenie položky je okamžite k dispozícii pri operácii opätovného načítanie schémy, ktorá sa uskutoční po výbere možnosti Povoliť .

Snímka obrazovky znázorňujúca možnosť povolenia dotazu mutácie zobrazenú v prieskumníkovi schém.

Dotazy alebo mutácie automaticky vytvorené z uložených procedúr možno odstrániť iba. Možno ich po odstránení znova pridať pomocou možností Získať údaje alebo Aktualizovať schému.

Súvisiaci obsah