Dela via

Infrastruktur-API för GraphQL-schemavy och schemautforskare

GraphQL-schemat, baserat på GraphQL Schema Definition Language (SDL), definierar formatet för de data som exponeras i API:et. Det ger flexibilitet för konsumenterna samtidigt som detaljer om backend-implementeringen döljs. Schemat använder en samling objekttyper som innehåller fält.

Schemavy

Öppna schemavyn genom att välja Schema i det nedre vänstra hörnet på skärmen Datautveckling. Den här vyn visar en textbaserad version av GraphQL SDL med genererade typer, fält och åtgärder.

Följande bild visar ett exempel på schemavyn, inklusive en lista över objekt som är tillgängliga i det här schemat.

Kommentar

Schemavyn är skrivskyddad. Ändra endast objekt i Schemautforskaren.

Skärmbild av skärmen för API-schemavyn, som innehåller Schemautforskaren i det vänstra fönstret.

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. Följande bild visar typen SalesOrderDetail som härletts från tabellen SalesOrderDetail i sql-analysslutpunkten AdventureWorks .

Skärmbild av fönstret Schemautforskaren som visar den expanderade listan över tillgängliga typer under en exempeldatakälla med namnet SalesOrderDetail.

Förutom typer genererar Fabric API för GraphQL automatiskt frågor och mutationer för 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.

Skärmbild av fönstret Schemautforskaren som visar en utökad lista över automatiskt genererade frågor.

Expandera noden mutationer i schemautforskarens träd för att se mutationerna som genereras automatiskt av API:et.

Skärmbild av fönstret Schemautforskaren som visar en utökad lista över automatiskt genererade mutationer.

Ä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 :

Skärmbild av schemautforskaren med ellipsen markerad med tillgängliga menyalternativ.

Följande alternativ är tillgängliga för typer:

  • Uppdateringsschema – Låter dig uppdatera schemat med nya objekt från datakällan.

  • Byt namn – Ändrar namnet på objektet. Den här ändringen påverkar bara API-schemat och påverkar inte det ursprungliga datakällans objekt som det härleds från.

  • Ta bort från schemat – Tar bort objektet från GraphQL-schemat, så du kan inte referera till det längre.

  • Hantera relationer – Öppnar upplevelsen för relationshantering. 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 eller 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 två andra alternativ:

  • Avaktivera: Förhindrar förfrågningar från att köra frågan eller mutationen. Om körningen görs returneras ett fel. När en fråga eller mutation har inaktiverats inträffar en schemaomläsning och frågan eller mutationen visas nedtonad i schemautforskaren.

Skärmbild av alternativet inaktivera fråga eller mutation som visas i schemautforskaren.

  • Aktivera: Gör att du kan återaktivera en tidigare inaktiverad fråga eller mutation. Frågan eller mutationen är omedelbart tillgänglig efter schemaomläsningsåtgärden som inträffar när du väljer alternativet Aktivera .

Skärmbild på alternativet för aktivera fråga om mutation som visas på schemautforskaren.

Frågor eller mutationer som genereras automatiskt från lagrade procedurer kan bara tas bort. Efter borttagningen kan de läsas med alternativen Hämta data eller Uppdatera schema .

Relaterat innehåll