Der Konfigurations-API-Endpunkt bietet umfassende Informationen, die für die Konfiguration des Layouts von Websites erforderlich sind. Er enthält zentrale Elemente wie:
- Container mit Seiten,
- eine umfangreiche Liste verfügbarer Slugs,
- Globals mit Daten aus dem Content-Pool,
- sowie wichtige Details zur Nitro-Konfiguration.
Der Endpunkt bietet einen ganzheitlichen Blick auf das Layout der Website und ermöglicht es Entwicklern, das Benutzererlebnis anzupassen und das Gesamtdesign zu optimieren.
🔗 Dokumentation: Nitro OpenAPI
Nitro-Konfiguration
Enthält grundlegende Informationen zur aktuellen Konfiguration der Nitro CMS-Integration:
- version → Version wird erhöht, sobald Flyo neue Daten generiert. Beim Caching sorgt dieser Wert für längere Speicherzyklen als updated_at.
- updated_at → Unix-Zeitstempel der letzten Aktualisierung der Integration. Wird für häufigere Cache-Updates genutzt als die version, denn der Zeitstempel steht nicht in Verbindung mit der Versionsnummer.
- language → Die aktuelle Sprache der Website.
Pages
Enthält ein Array von Slugs, das alle registrierten Seiten-URLs der Website ausgibt. Entwickler können prüfen, ob eine angeforderte URL existiert oder eine 404-Fehlermeldung zurückgegeben werden bzw. die Anfrage abweichend behandelt werden soll. Durch die Nutzung des Arrays können die in der Applikation (Frontend) verwendeten Slugs leicht verwaltet und kontrolliert werden. Damit kann sichergestellt werden, dass nur gültige und registrierte Routen zugänglich sind. Dieser Ansatz hilft, die Integrität und Sicherheit der Navigation Ihrer Website zu wahren und verhindert, dass Benutzer auf undefinierte oder unbefugte Seiten zugreifen.
Containers
Enthält Container, die für die Bereitstellung der Navigationsbereiche unerlässlich sind. Jeder Navigationsbereich (z.B. Hauptnavigation, Footer Nav, etc.) befindet sich in einem eigenen Container. Jeder Container enthält:
- Label → Beschreibt den Zweck oder die Position des Menüs (z. B. "Hauptnavigation", "Footer Nav").
- Identifikator (Slug) → Ein eindeutiger Name zur einfachen Referenzierung (z. B. "footer-nav").
- Items-Objekt → Dieses Objekt enthält die eigentlichen Seitenelemente, die die Struktur des Menüs ausmachen.
Globals
Der Globals-Bereich ist ein wichtiger Bestandteil der Website-Struktur. Er enthält ein assoziatives Array, in dem Entwickler eigene Schlüssel definieren können. Jeder Schlüssel verweist auf eine Liste von Elementen, die Daten aus Content Pools enthalten. Diese globalen Daten stehen überall auf der Website zur Verfügung und lassen sich effizient verwalten und abrufen.