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-slutpunkt

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 skriva vilken text som helst.
    • Använd GraphQL-schema från: Använd listrutan för att välja önskad konfiguration.
  4. Bekräfta med Skapa.

  5. I konsolen finns en Bana kommer nu att visas baserat på den konfiguration som skapades tidigare. Det här är sökvägen som 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 måste utforma frågor för sina kanalslutpunkter för att kunna leverera innehåll. Dessa frågor behöver i allmänhet bara övervägas en gång per slutpunkt och modell. I den här guiden behöver vi bara skapa en.

GraphiQL är en integrerad utvecklingsmiljö som ingår i AEM. den är tillgänglig/synlig efter att du har 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 webbläsarredigerare 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 listrutan högst 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 vi skapade anropades person med fält firstName, lastNameoch positionkan vi skapa en enkel fråga för att hämta innehållet i vårt innehållsfragment.

    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å Dokument på sidans övre högra hörn för att visa sammanhangsberoende dokumentation som hjälper dig att skapa frågor som anpassar sig till dina egna modeller.
    GraphiQL-dokumentation

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

GraphQL kan undvika både iterativa API-begäranden och överleverans, och i stället möjliggör 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 förstås många fler resurser där du kan fördjupa dig i en heltäckande bild av de funktioner som finns.

På denna sida