Köra enkla GraphQL-frågor

Välkomna till en lektion om att köra GraphQL-frågor! I den här lektionen lär ni er att hämta data från en GraphQL-server.

En GraphQL-fråga är det sätt på vilket en klientapplikation ber servern om data. Till skillnad från traditionella REST-API:er, där ni ofta får fasta datastrukturer, låter GraphQL er ange exakt vilka data ni behöver.

För att köra frågor använder vi ofta interaktiva verktyg. Två populära alternativ är GraphiQL och GraphQL Playground.

• De är webbläsarbaserade IDE:er (integrerade utvecklingsmiljöer).
• De erbjuder funktioner som schemautforskning, automatisk komplettering av frågor och dokumentation.
• De ansluter till GraphQL-serverns endpoint för att skicka frågor och visa resultat.

En GraphQL-fråga börjar med att välja fält från rottypen Query. Ni anger vilka fält ni vill ha, och servern returnerar endast dessa data.

Nyckelordet query är valfritt i enkla frågor, men det är god praxis att ta med det för tydlighetens skull och för att kunna namnge era operationer.

Anta att vårt schema har en Book-typ med fälten title och author. För att hämta en lista över alla böcker med deras titlar och författare skriver vi:

Observera att klammerparenteserna {} definierar en urvalsuppsättning för fältet allBooks.

En av GraphQL:s styrkor är att ni kan fråga efter nästlade data i en enda begäran. Om fältet author är av en objekttyp med egna fält, till exempel name och nationality, kan ni även välja dem:

Detta hämtar böckerna samt deras författares namn och nationaliteter på en gång!

Ni kan skicka argument till fält för att filtrera, göra sidindelning eller ange ett specifikt objekt. Argument definieras i schemat och fungerar som funktionsparametrar.

För att till exempel hämta en specifik bok med dess ID:

Här är id: "1" ett argument som skickas till fältet bookById.

Vad gör ni om ni behöver fråga efter samma fält flera gånger med olika argument? Med alias kan ni byta namn på resultatet från ett fält.

Det förhindrar konflikter i JSON-svaret när samma fältnamn annars skulle förekomma flera gånger:

Resultaten blir firstBook och secondBook.

Fragment är återanvändbara enheter för urvalslogik. De låter er definiera en uppsättning fält en gång och sedan återanvända den i flera frågor eller på flera ställen i samma fråga.

Detta är användbart för komplexa frågor eller när olika delar av ert användargränssnitt behöver samma delmängd data:

Syntaxen ...BookDetails infogar fragmentets fält i frågan.

Att ge era frågor ett operationsnamn, till exempel GetBookDetails, underlättar felsökning och loggning på serversidan.

Ni kan även definiera variabler för att skicka dynamiska data till era frågor, vilket gör dem mer flexibla:

Variabeln $bookId skulle skickas separat, vanligtvis som ett JSON-objekt, till exempel {"bookId": "3"}, i ert frågeverktyg.

Ha följande tips i åtanke när ni formulerar era frågor:

• Var specifika: Be bara om de data ni verkligen behöver.
• Använd fragment: För återanvändbara urvalsuppsättningar, särskilt i olika delar av applikationen.
• Namnge operationer: Det underlättar felsökning och övervakning.
• Använd variabler: För dynamiska argument i stället för att skriva in värden direkt i frågesträngen.
• Utforska schemat: Använd dokumentationsutforskaren i GraphiQL/Playground för att förstå vilka fält och argument som är tillgängliga.

Bra jobbat! Ni har gått igenom grunderna i att köra GraphQL-frågor:

• Hur frågor anger exakt vilka data som ska hämtas.
• Hur ni använder verktyg som GraphiQL och GraphQL Playground.
• Den grundläggande strukturen, inklusive val av fält och nästlade data.
• Hur ni skickar argument till fält för filtrering.
• Hur ni använder alias för att byta namn på fältresultat.
• Hur ni använder fragment för återanvändbara urvalsuppsättningar.
• Vikten av operationsnamn och variabler.

Nu är ni redo att börja hämta data effektivt!