Hantera GraphQL-slutpunkter i AEM

Slutpunkten är den sökväg som används för att komma åt GraphQL för AEM. Med den här sökvägen kan du (eller din app):

  • tillgång till GraphQL schema,
  • skicka dina GraphQL-frågor,
  • ta emot svaren (på dina GraphQL-frågor).

Det finns två typer av slutpunkter i AEM:

  • Global
    • Tillgängligt för alla webbplatser.
    • Den här slutpunkten kan använda alla modeller för innehållsfragment från alla platskonfigurationer (definieras i Konfigurationsläsaren).
    • Om det finns några modeller för innehållsfragment som ska delas mellan platskonfigurationer, ska dessa skapas under de globala platskonfigurationerna.
  • Platskonfigurationer:
    • Motsvarar en platskonfiguration, enligt definitionen i Konfigurationsläsaren.
    • Specifikt för en angiven plats/ett angivet projekt.
    • En platskonfigurationsspecifik slutpunkt använder innehållsfragmentmodellerna från den specifika platskonfigurationen tillsammans med de från den globala platskonfigurationen.
FÖRSIKTIGHET

Innehållsfragmentsredigeraren kan tillåta att ett innehållsfragment av en platskonfiguration refererar till ett innehållsfragment av en annan platskonfiguration (via principer).

I så fall går det inte att hämta allt innehåll med en platskonfigurationsspecifik slutpunkt.

Innehållsförfattaren bör kontrollera detta scenario; Det kan till exempel vara bra att överväga att placera delade modeller för innehållsfragment under konfigurationen för globala platser.

Databassökvägen för den globala slutpunkten för GraphQL AEM är:

/content/cq:graphql/global/endpoint

För vilken ditt program kan använda följande sökväg i URL:en för begäran:

/content/_cq_graphql/global/endpoint.json

Om du vill aktivera en slutpunkt för GraphQL för AEM måste du:

Aktivera din GraphQL-slutpunkt

Om du vill aktivera en GraphQL-slutpunkt måste du först ha en lämplig konfiguration. Se Content Fragments - Configuration Browser.

FÖRSIKTIGHET

Om användning av innehållsfragmentmodeller inte har aktiverats, Skapa kommer inte att vara tillgängligt.

Så här aktiverar du motsvarande slutpunkt:

  1. Navigera till verktyg, Allmänt väljer GraphQL.

  2. Välj Skapa.

  3. The Skapa ny GraphQL-slutpunkt öppnas. Här kan du ange:

    • Namn: Slutpunktens namn. du kan skriva vilken text som helst.
    • Använd GraphQL-schema från: Använd listrutan för att välja önskad plats/önskat projekt.
    OBSERVERA

    Följande varning visas i dialogrutan:

    • GraphQL slutpunkter kan medföra problem med datasäkerhet och prestanda om de inte hanteras varsamt. Kontrollera att du har angett rätt behörigheter när du har skapat en slutpunkt.

  4. Bekräfta med Skapa.

  5. The Nästa steg kommer att innehålla en direktlänk till säkerhetskonsolen så att du kan se till att den nyskapade slutpunkten har rätt behörigheter.

    FÖRSIKTIGHET

    Slutpunkten är tillgänglig för alla. Detta kan - särskilt när det gäller publiceringsinstanser - utgöra ett säkerhetsproblem, eftersom GraphQL-frågor kan belasta servern mycket.

    Du kan ställa in åtkomstkontrollistor, som passar ditt användningsfall, på slutpunkten.

Publicera din GraphQL-slutpunkt

Markera den nya slutpunkten och Publicera för att göra den helt tillgänglig i alla miljöer.

FÖRSIKTIGHET

Slutpunkten är tillgänglig för alla.

På publiceringsinstanser kan detta utgöra ett säkerhetsproblem, eftersom GraphQL-frågor kan medföra en stor belastning på servern.

Du måste konfigurera Behörighetslistor som passar ditt användningsfall på slutpunkten.

På denna sida