Infrastruktur-API för GraphQL-schemavy och Schemautforskaren
GraphQL-schemat, som baseras på GraphQL Schema Definition Language (SDL), definierar formatet för de data som exponeras i API:et. Det är ett abstraktionslager som ger konsumenterna flexibilitet samtidigt som serverdelsimplementeringsinformationen döljs. Schemat baseras på en samling objekttyper som innehåller fält.
Schemavy
Du kan komma åt schemavyn genom att välja Schema i det nedre vänstra hörnet på skärmen Datautveckling. Vyn visar en textbaserad version av GraphQL SDL med genererade typer, fält och åtgärder.
Följande bild är ett exempel på schemavyn, inklusive en omfattande lista över objekt som är tillgängliga i det här schemat.
Kommentar
Schemavyn är skrivskyddad. Du kan bara ändra objekt i Schemautforskaren.
Schemautforskaren
Schemautforskaren finns i fönstret till vänster och är också tillgänglig när du använder redigeraren i frågevyn. Utforskaren gör det möjligt för användare att snabbt visualisera tillgängliga typer och fält, samt frågor och mutationer som definieras i API:et.
Alla GraphQL-typer som är tillgängliga från de objekt du väljer när du ansluter till en datakälla visas i listan Schemautforskaren. Typerna visas under namnet på den datakälla som de härleddes från. I följande bild visas typen SalesOrderDetail som härletts från tabellen SalesOrderDetail i sql-analysslutpunkten AdventureWorks .
Förutom typer genererar Fabric-API:et för GraphQL automatiskt frågor och mutationer för alla nya objekt som du väljer att exponera.
I vårt AdventureWorks-exempel visar en utökning av listan med frågor de automatiskt genererade frågorna för datakällan.
Om du vill se mutationerna som genereras automatiskt av API:et expanderar du noden mutationer i schemautforskarens träd.
Ändra objekt med hjälp av Schemautforskaren
Du kan använda Schemautforskaren för att ändra objekt när API:et har skapat dem åt dig. I följande exempel väljer vi ellipsen bredvid typen SalesOrderDetail som härletts från vår AdventureWorks-databas :
Följande alternativ är tillgängliga för typer:
- Uppdateringsschema – Gör att du kan uppdatera schemat med nya objekt från datakällan.
- Byt namn – Ändrar namnet på objektet. OBS! Den här ändringen påverkar bara API-schemat och har ingen effekt på det ursprungliga datakällans objekt som det härleddes från.
- Ta bort från schemat – Tar effektivt bort objektet från GraphQL-schemat så att du inte längre kan referera till det.
- Hantera relationer – Tar dig till relationshanteringsmiljön. Mer information finns i Hantera relationer i Fabric API för GraphQL.
- Egenskaper – Visar ytterligare information om objektet.
Aktivera och inaktivera frågor och mutationer
Funktionen aktivera/inaktivera för frågor och mutationer ger administratörer och utvecklare detaljerad kontroll över API-åtkomst och -användning. Du kan selektivt aktivera eller inaktivera specifika frågor och mutationer i GraphQL-schemat. På så sätt kan du hantera API-funktioner dynamiskt utan att ändra kod eller distribuera ändringar.
Frågor och mutationer i schemautforskaren har ytterligare två alternativ:
- Inaktivera – förhindrar att begäranden kör frågan eller mutationen. Om körningen görs returneras ett fel. När en fråga eller en mutation har inaktiverats inträffar en schemaomläsning och frågan eller mutationen visas nedtonad i schemautforskaren.
- Aktivera – Återaktivera en tidigare inaktiverad fråga eller mutation. Körning av objektet är omedelbart tillgängligt vid schemaomläsning som utförs efter att alternativet Aktivera har valts.
Observera att frågor eller mutationer som genereras automatiskt från lagrade procedurer bara kan tas bort. När de har tagits bort kan de läggas till igen med alternativen Hämta data eller Uppdatera schema .