En implementering av standarden GraphiQL IDE kan användas med GraphQL API för Adobe Experience Manager (AEM) as a Cloud Service.
GraphiQL ingår i alla miljöer med AEM (men är bara tillgängligt/synligt när du konfigurerar slutpunkterna).
I tidigare versioner behövdes ett paket för att installera GraphiQL IDE. Om du har installerat den kan den nu tas bort.
Du måste ha konfigurerade dina slutpunkter i konfigurationsläsare innan du använder GraphiQL IDE.
The GraphiQL kan du testa och felsöka dina GraphQL-frågor genom att aktivera:
dev-publish
)Du kan öppna frågeredigeraren från:
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 man sedan flytta frågor till produktionsmiljön. Till att börja med måste produktionsförfattaren validera nyskrivet innehåll med frågorna och till sist publicera produktionen för direktkonsumtion.
Som ett första steg måste du välja 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.
Du kan ange den nya frågan i redigeraren, som finns i den vänstra panelen, direkt under GraphiQL-logotypen.
Om du redan har markerat en beständig fråga och vill visa den på redigeringspanelen väljer du +
(bredvid Beständiga frågor) för att tömma redigeraren som är klar för den nya frågan.
Börja skriva - redigeraren:
GraphQL-frågor börjar oftast med en {
tecken.
Rader som börjar med en #
ignoreras.
Använd Spara som för att behålla den nya frågan.
Välj frågan som du vill uppdatera i listan i dialogrutan Beständiga frågor panel (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 implementera uppdateringar av den beständiga frågan.
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:
Control-Enter
Med GraphiQL IDE kan du också hantera Frågevariabler.
Till exempel:
Beständiga frågor rekommenderas eftersom de kan cachelagras på dispatcher- och CDN-lagren, vilket i slutänden förbättrar prestanda för det begärande klientprogrammet. Som standard blir cacheminnet för innehållsleveransnätverket (CDN) ogiltigt baserat på en TTL-standardinställning (Time To Live).
Mer information finns i Cachelagra beständiga frågor.
Anpassade omskrivningsregler för Dispatcher kan åsidosätta standardvärden från AEM publicering.
Om du skickar TTL-baserade headers för cachekontroll från dispatchern, baserat på ett matchningsmönster för plats, kan du vid behov utelämna /graphql/execute.json/*
från matcherna.
Med GraphQL kan du konfigurera HTTP-cache-rubrikerna för att styra de här parametrarna för din enskilda beständiga fråga.
The Sidhuvuden är tillgängligt via de tre lodräta prickarna till höger om det beständiga frågenamnet (längst till vänster):
Om du väljer det här alternativet öppnas Cachekonfiguration dialog:
Välj lämplig parameter och justera sedan värdet efter behov:
Välj Spara för att behålla ändringarna.
När du har valt din beständiga fråga i listan (den vänstra panelen) kan du använda Publicera och Avpublicera åtgärder. Detta aktiverar dem till din publiceringsmiljö (till exempel dev-publish
) för enkel åtkomst av dina program vid testning.
Definitionen av den beständiga frågans cache Time To Live
{"cache-control":"parameter":value} har standardvärdet 2 timmar (7 200 sekunder).
The 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. till exempel 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:
The 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):
The Ta bort Du kan även använda det här alternativet via de tre lodräta prickarna till höger om det beständiga frågenamnet (längst till vänster).
När du har utvecklat och testat din beständiga fråga med GraphiQL är det sista målet att överföra den till produktionsmiljön som kan användas i dina program.
Det finns ett urval av kortkommandon som ger direktåtkomst till åtgärdsikoner i den integrerade utvecklingsmiljön:
Shift-Control-P
Shift-Control-M
Control-Enter
Control-Space
På vissa tangentbord på Control
tangenten är märkt som Ctrl
.