Skapa en API-begäran - Headless-konfiguration

Lär dig hur du använder GraphQL API för headless-leverans av Content Fragment-innehåll och AEM Assets REST API för att hantera innehållsfragment.

Vad är GraphQL och Assets REST API:er?

Nu när du har skapat några innehållsfragment, kan du använda AEM-API:er för att leverera dem utan problem.

Resten av guiden fokuserar på GraphQL åtkomst och leverans av innehållsfragment.

Aktivera GraphQL Endpoint

Innan GraphQL API:er kan användas måste en GraphQL-slutpunkt skapas.

  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 ange valfri text.
    • Använd GraphQL-schema från: använd listrutan för att välja önskad konfiguration.

  4. Bekräfta med Skapa.

  5. I konsolen Bana visas baserat på konfigurationen som skapades tidigare. Den här sökvägen används för att köra GraphQL-frågor.

    /content/cq:graphql/<configuration-name>/endpoint

Mer information om aktivering GraphQL-slutpunkter finns här.

Fråga innehåll med GraphQL med GraphiQL

Informationsarkitekterna skapar frågor om sina kanalslutpunkter för att leverera innehåll. Ta hänsyn till dessa frågor endast en gång per slutpunkt, per modell. För att komma igång-guiden behöver du bara skapa en.

GraphiQL är en integrerad utvecklingsmiljö som ingår i AEM. Den är tillgänglig/synlig när du har gjort det konfigurera dina slutpunkter.

  1. Logga in AEM as a Cloud Service och gå till GraphiQL-gränssnittet:

    Du kan öppna frågeredigeraren från:

    • verktyg -> Allmänt -> GraphQL Query Editor
    • direkt, till exempel http://localhost:4502/aem/graphiql.html

  2. GraphiQL IDE är en frågeredigerare i webbläsaren för GraphQL. Du kan använda den för att skapa frågor för att hämta innehållsfragment och leverera dem i headlessläge som JSON.

    • I den nedrullningsbara menyn längst upp till höger kan du välja slutpunkten.
    • I en panel längst till vänster visas de beständiga frågorna (om de är tillgängliga)
    • På panelen i mitten till vänster kan du skapa din fråga.
    • Resultaten visas på panelen i det mittersta högra hörnet.
    • Frågeredigeraren har funktioner för kodkomplettering och snabbtangenter för att enkelt köra frågan.

    GraphiQL editor

  3. Anta att modellen du skapade anropades person med fält firstName, lastNameoch positionkan du skapa en enkel fråga som hämtar innehållet i innehållsfragmentet.

    query
{
  personList {
    items {
      _path
      firstName
      lastName
      position
    }
  }
}

  4. Skriv frågan i den vänstra panelen.
    GraphiQL-fråga

  5. Klicka på Kör fråga eller använder Ctrl-Enter snabbtangenten och resultatet visas som JSON i den högra panelen.
    GraphiQL-resultat

  6. Klicka på i det övre högra hörnet på sidan Dokument om du vill visa sammanhangsberoende dokumentation så att du kan skapa frågor som anpassar sig efter dina egna modeller.
    GraphiQL-dokumentation

GraphQL möjliggör strukturerade frågor som inte bara kan rikta sig till specifika datauppsättningar eller enskilda dataobjekt, utan även kan leverera specifika element i objekten, kapslade resultat, har stöd för frågevariabler och mycket annat.

GraphQL kan undvika iterativa API-förfrågningar och överleverans, och tillåter istället massleverans av exakt det som behövs för återgivning som svar på en enda API-fråga. Den resulterande JSON kan användas för att leverera data till andra webbplatser eller appar.

Nästa steg

Så ja! Ni har nu en grundläggande förståelse för innehållshantering utan problem i AEM. Det finns många fler resurser där du kan fördjupa dig för att få en heltäckande bild av de funktioner som finns.

På denna sida