Olvasás angol nyelven

Megosztás a következőn keresztül:

Fabric API GraphQL-sémanézethez és Sémakezelőhöz

  • Cikk

A GraphQL-séma, amely a GraphQL sémadefiníciós nyelvén (SDL) alapul, meghatározza az API-ban közzétett adatok formátumát. Ez egy absztrakciós réteg, amely rugalmasságot biztosít a felhasználók számára, miközben elrejti a háttérbeli megvalósítás részleteit. A séma olyan objektumtípusok gyűjteményén alapul, amelyek mezőket tartalmaznak.

Sémanézet

A sémanézethez az Adatfejlesztési képernyő bal alsó sarkában található Séma elemet választva érheti el. A nézet a GraphQL SDL szöveges verzióját jeleníti meg generált típusokkal, mezőkkel és műveletekkel.

Az alábbi kép egy példa a sémanézetre, beleértve a sémában elérhető objektumok széles listáját.

Megjegyzés

A sémanézet írásvédett. Csak a Sémakezelőben módosíthatja az objektumokat.

Képernyőkép az API sémanézetének képernyőjéről, amely tartalmazza a sémakezelőt a bal oldali panelen.

Sémakezelő

A Sémakezelő a bal oldali panelen található, és akkor is elérhető, ha a szerkesztőt használja a lekérdezési nézetben. Az Explorer segítségével a felhasználók gyorsan megjeleníthetik az API-ban definiált elérhető típusokat és mezőket, valamint lekérdezéseket és mutációkat.

Az adatforráshoz való csatlakozáskor kiválasztott objektumokból elérhető Összes GraphQL-típus megjelenik a Sémakezelő listában. A típusok annak az adatforrásnak a neve alatt jelennek meg, amelyből származtatták őket. Az alábbi képen az AdventureWorks SQL Analytics-végpont SalesOrderDetail táblájából származtatott SalesOrderDetail típus látható.

Képernyőkép a Sémakezelő panelről, amelyen a SalesOrderDetail nevű példaadatforrásban elérhető típusok kibontott listája látható.

A típusok mellett a GraphQL-hez készült Fabric API automatikusan lekérdezéseket és mutációkat hoz létre a felfedni kívánt új objektumokhoz.

Az AdventureWorks-példában a lekérdezések listájának kibontásával az adatforrás automatikusan generált lekérdezései láthatók.

Képernyőkép a Sémakezelő panelről, amelyen az automatikusan létrehozott lekérdezések bővített listája látható.

Az API által automatikusan generált mutációk megtekintéséhez bontsa ki a mutációk csomópontját a Sémakezelő fán.

Képernyőkép a Sémakezelő panelről, amelyen az automatikusan létrehozott mutációk bővített listája látható.

Objektumok módosítása a Sémakezelővel

A Sémakezelővel módosíthatja az objektumokat, miután az API létrehozta őket Önnek. Az alábbi példában az AdventureWorks-adatbázisból származó SalesOrderDetail típus melletti három pontot választjuk ki:

Képernyőkép a Sémakezelőről, amelyen a három pont van kiválasztva, és megjeleníti az elérhető menübeállításokat.

A típusok esetében a következő lehetőségek érhetők el:

  • Séma frissítése – Lehetővé teszi a séma frissítését az adatforrás új objektumaival.
  • Átnevezés – Módosítja az objektum nevét. MEGJEGYZÉS: Ez a módosítás csak az API-sémát érinti, és nincs hatással az eredeti adatforrás-objektumra, amelyből származik.
  • Eltávolítás a sémából – Hatékonyan törli az objektumot a GraphQL-sémából, így már nem hivatkozhat rá.
  • Kapcsolatok kezelése – A kapcsolatkezelési felületre viszi. További információ: Kapcsolatok kezelése a Fabric API for GraphQL-ben.
  • Tulajdonságok – További információkat jelenít meg az objektumról.

Lekérdezések és mutációk engedélyezése és letiltása

A lekérdezések és mutációk engedélyezésével/letiltásával a rendszergazdák és fejlesztők részletes vezérlést biztosítanak az API-hozzáférés és -használat felett. Lehetővé teszi bizonyos lekérdezések és mutációk szelektív aktiválását vagy inaktiválását a GraphQL-sémában. Ez lehetővé teszi az API-képességek dinamikus kezelését a kód módosítása vagy a módosítások üzembe helyezése nélkül.

A sémakezelő lekérdezéseinek és mutációinak két további lehetősége van:

  • Letiltás – Megakadályozza, hogy a kérések végrehajtják a lekérdezést vagy a mutációt. Ha végrehajtást kísérel meg, a rendszer hibát ad vissza. Ha egy lekérdezés vagy mutáció le van tiltva, a séma újratöltése megtörténik, és a lekérdezés vagy a mutáció szürkítve jelenik meg a sémakezelőben.

Képernyőkép a sémakezelőben megjelenő lekérdezés vagy mutáció letiltásának lehetőségéről.

  • Engedélyezés – Korábban letiltott lekérdezés vagy mutáció újbóli engedélyezése. Az elem végrehajtása azonnal elérhető a séma újrabetöltési műveletekor, amely az Engedélyezés lehetőség kiválasztása után történik.

Képernyőkép a sémakezelőben látható mutációs beállítás engedélyezéséről.

Vegye figyelembe, hogy a tárolt eljárásokból automatikusan létrehozott lekérdezések vagy mutációk csak törölhetők. A törlés után újra hozzáadhatók az Adatok lekérése vagy a Séma frissítése lehetőséggel.

Kapcsolódó tartalom