Erkunden Sie die AEM OpenAPI-basierten APIs zur Bereitstellung von Inhaltsfragmenten

Die Bereitstellung von AEM-Inhaltsfragmenten mit OpenAPIs in AEM bietet eine leistungsstarke Möglichkeit, strukturierte Inhalte für jede Anwendung oder jeden Kanal bereitzustellen. In diesem Kapitel erkunden wir, wie Sie mit den OpenAPIs Inhaltsfragmente über die Funktion "ausprobieren“ Dokumentation abrufen können.

Voraussetzungen prerequisites

Dies ist ein mehrteiliges Tutorial und setzt voraus, dass die unter Erstellen von Inhaltsfragmenten beschriebenen Schritte abgeschlossen sind.

Stellen Sie sicher, dass Sie Folgendes haben:

Ziele objectives

Bereitstellungs-APIs

Die Bereitstellung von AEM-Inhaltsfragmenten mit OpenAPIs bietet eine RESTful-Schnittstelle zum Abrufen von Inhaltsfragmenten. Die in diesem Tutorial behandelten APIs sind nur für die Veröffentlichungs- und Vorschau-Services von AEM verfügbar, nicht für den Autoren-Service. Es gibt weitere OpenAPIs für Interaktion mit Inhaltsfragmenten im AEM-Autoren-Service.

Erkunden der APIs

Bereitstellung von AEM-Inhaltsfragmenten mit OpenAPIs - Dokumentation Verfügen über eine Funktion zum „Probieren Sie es aus“, mit der Sie die APIs untersuchen und direkt im Browser testen können. Dies ist eine hervorragende Möglichkeit, sich mit den API-Endpunkten und ihren Funktionen vertraut zu machen.

Öffnen Sie die AEM Sites-APIDokumente in Ihrem Browser.

Die APIs werden im linken Navigationsbereich unter dem Abschnitt Fragmentbereitstellung aufgeführt. Sie können diesen Abschnitt erweitern, um die verfügbaren APIs anzuzeigen. Wenn Sie eine API auswählen, werden im Hauptbedienfeld die API-Details und in der rechten Leiste ein Probieren-Abschnitt angezeigt, in dem Sie die API direkt im Browser testen und erkunden können.

Auflisten von Inhaltsfragmenten

Mit dieser API können Sie eine paginierte Liste aller Inhaltsfragmente aus AEM nach Ordner abrufen. Die einfachste Möglichkeit, diese API zu verwenden, besteht darin, den Pfad zum Ordner mit den Inhaltsfragmenten anzugeben.

Da wir den AEM-Veröffentlichungs-Service verwenden, setzen Sie den Bucket auf die Kennung des AEM-Veröffentlichungs-Service. Beispiel:

Wenn der Bucket festgelegt ist, wird das Feld Target-Server automatisch auf die vollständige API-URL des AEM-Veröffentlichungs-Service aktualisiert, z. B.: https://publish-p138003-e1400351.adobeaemcloud.com/adobe/contentFragments

Abrufen von Inhaltsfragmentdetails

Ähnlich wie die Alle Inhaltsfragmente auflisten-API ruft die Inhaltsfragment abrufen-API ein einzelnes Inhaltsfragment nach seiner ID sowie alle optionalen Verweise ab. Um diese API zu erkunden, fordern wir das Team-Inhaltsfragment an, das auf mehrere Personen-Inhaltsfragmente verweist.

Verwenden Sie in diesem Beispiel die ID des im vorherigen Abschnitt abgerufenen Team-Inhaltsfragments. Verwenden Sie beispielsweise für diese Inhaltsfragmentantwort in Alle Inhaltsfragmente auflisten den Wert im id -Feld von b954923a-0368-4fa2-93ea-2845f599f512. (Ihr id unterscheidet sich von dem im Tutorial verwendeten Wert.)

{
    "path": "/content/dam/my-project/teams/team-alpha",
    "name": "",
    "title": "Team Alpha",
    "id": "50f28a14-fec7-4783-a18f-2ce2dc017f55", // This is the Content Fragment ID
    "description": "",
    "model": {},
    "fields": {}
}

Beachten Sie, dass das teamMembers-Array jetzt die Details der referenzierten personenbezogenen Inhaltsfragmente enthält. Hydratisierende Referenzen ermöglichen es Ihnen, alle erforderlichen Daten in einem einzigen API-Aufruf abzurufen, was besonders nützlich ist, um die Anzahl der von Client-Anwendungen gestellten Anfragen zu reduzieren.

Herzlichen Glückwunsch!

Herzlichen Glückwunsch! Sie haben mehrere AEM-Inhaltsfragmentbereitstellungen mit OpenAPI-Aufrufen erstellt und ausgeführt, indem Sie die AEM-Dokumentationsfunktion "it“.

Nächste Schritte

Im nächsten Kapitel Erstellen einer React-App erfahren Sie, wie eine externe Anwendung mit der Bereitstellung von AEM-Inhaltsfragmenten mit OpenAPIs interagieren kann.