Använda GraphiQL IDE graphiql-ide
En implementering av standardmiljön GraphiQL finns tillgänglig för användning med GraphQL API för Adobe Experience Manager (AEM).
Med verktyget GraphiQL kan du testa och felsöka dina GraphQL-frågor genom att aktivera:
- välj den slutpunkt som passar den platskonfiguration som du vill använda för dina frågor
- direkt mata in nya frågor
- skapa och få åtkomst till beständiga frågor
- köra dina frågor för att omedelbart se resultatet
- hantera frågevariabler
- spara och hantera beständiga frågor
- publicera, eller avpublicera, beständiga frågor (till exempel till/från
dev-publish) - visa historiken för dina tidigare frågor
- använd Dokumentationsutforskaren för att få tillgång till dokumentationen och för att lära dig mer och förstå vilka metoder som är tillgängliga.
Du kan öppna frågeredigeraren från:
- Verktyg > Allmänt > GraphQL Query Editor
- direkt, till exempel
http://localhost:4502/aem/graphiql.html
Du kan använda GraphiQL på datorn så att frågor kan begäras av klientprogrammet med hjälp av GET-förfrågningar och för publiceringsfrågor. För produktionsanvändning kan du sedan flytta dina frågor till din produktionsmiljö. Till att börja med måste produktionsförfattaren validera nyskrivet innehåll med frågorna och till sist publicera produktionen för direktkonsumtion.
Markera slutpunkten selecting-endpoint
Som ett första steg måste du välja den slutpunkt som du vill använda för frågorna. Slutpunkten passar den platskonfiguration som du vill använda för dina frågor.
Det här är tillgängligt i listrutan högst upp till höger.
Skapa och behålla en ny fråga creating-new-query
Du kan ange den nya frågan i redigeraren, som finns i den vänstra panelen, direkt under GraphiQL-logotypen.
+ (bredvid Beständiga frågor) för att tömma redigeraren som är klar för den nya frågan.Börja skriva - redigeraren:
- använder muspekaren för att visa ytterligare information om element
- innehåller funktioner som syntaxmarkering, automatisk komplettering och automatisk föreslå
{-tecken.# ignoreras.Använd Spara som om du vill behålla den nya frågan.
Uppdaterar din beständiga fråga updating-persisted-query
Markera frågan som du vill uppdatera i listan på panelen Beständiga frågor (längst till vänster).
Frågan visas på redigeringspanelen. Gör de ändringar du behöver och använd sedan Spara för att genomföra uppdateringarna i den beständiga frågan.
Köra frågor running-queries
Du kan köra en ny fråga direkt eller läsa in och köra en beständig fråga. Om du vill läsa in en beständig fråga väljer du den i listan. Frågan visas i redigeringspanelen.
I båda fallen är frågan som visas på redigeringspanelen den fråga som kommer att köras när du antingen:
- klicka på ikonen Kör fråga
- använd tangentbordskombinationen
Control-Enter
Frågevariabler query-variables
Med GraphiQL IDE kan du också hantera dina frågevariabler.
Till exempel:
Publicera beständiga frågor publishing-persisted-queries
När du har valt din beständiga fråga i listan (den vänstra panelen) kan du använda åtgärderna Publish och Avpublicera. Detta aktiverar dem i din publiceringsmiljö (till exempel dev-publish) så att de blir lätta att komma åt när du testar program.
Time To Live {"cache-control":"parameter":value} har standardvärdet 2 timmar (7 200 sekunder).Kopiera URL för direktåtkomst till frågan copy-url
Med alternativet Kopiera URL kan du simulera en fråga genom att kopiera den URL som används för att få direkt åtkomst till den beständiga frågan och se resultatet. Detta kan sedan användas för testning, t.ex. genom att gå till i en webbläsare:
Till exempel:
http://localhost:4502/graphql/execute.json/global/article-list-01
Genom att använda den här URL:en i en webbläsare kan du bekräfta resultatet:
Alternativet Kopiera URL är tillgängligt via de tre lodräta prickarna till höger om det beständiga frågenamnet (längst till vänster):
Tar bort beständiga frågor deleting-persisted-queries
Alternativet Ta bort är även tillgängligt via de tre lodräta prickarna till höger om det beständiga frågenamnet (längst till vänster).
Installera den beständiga frågan i produktionen installing-persisted-query-production
När du har utvecklat och testat din beständiga fråga med GraphiQL är det slutliga målet att överföra den till din produktionsmiljö för användning i dina program.
Kortkommandon keyboard-shortcuts
Det finns ett urval av kortkommandon som ger direktåtkomst till åtgärdsikoner i den integrerade utvecklingsmiljön:
- Pretify-fråga:
Shift-Control-P - Kopplingsfråga:
Shift-Control-M - Kör fråga:
Control-Enter - Komplettera automatiskt:
Control-Space
Control märkt som Ctrl.