4.2. API - Schnittstelle

API - Endpunkte

• ComponentConfig
• ContentText
• Domain
• Navigation
• NavigationItem
• Page
• Site
• Version

Grundsätzliches

GET Requests haben reguläre URL-Parameter als parameter.
Bespiel: /api/endpoint?foo=bar&id=2

POST/PUT/DELETE requests transportieren die Parameter im body als JSON objekt. Ausnahme ist die ID, welche das zu modifizierende Entity referenziert.
Beispiel DELETE /api/endpoint/[id]

Responses sind im Regelfall JSON objekte.

[Entity]ListResponse

ListResponses sind immer gleich aufgebaut.

{
  "items": [
    {
      "id": "uuid"
    }
  ],
  "total": 0
}

• items beinhaltet die Liste der abgefragten Elemente. Das kann bei Serve-Seitiger Pagination auch eine Teilmenge der abgefragten Elemente sein.
• total die Gesamtanzahl der gefundenen Elemente, die abgefragt wurde.