API Demo mit sg_apicore

sg_apicore ist das moderne API-Framework für TYPO3. Diese Seite zeigt den produktiven Standard-Workflow ohne Legacy- oder sg_rest-Anteile.

  • Attribute-basiertes Routing
  • OpenAPI/Swagger-Dokumentation
  • Token-, User- und Scope-basierte Absicherung
  • Pagination, Caching, Rate Limiting und Logging

Live API Explorer

Swagger UI in neuem Tab öffnen
OpenAPI JSON anzeigen

Schnellstart

  1. API in ext_localconf.php registrieren.
  2. Controller in Configuration/Services.php mit sg_apicore.router taggen.
  3. Endpoints per Attribute definieren (ApiRoute, ApiEndpoint, ApiQueryParam, ApiResponse).
  4. Antworten über ResponseService erzeugen.
curl "https://websitebase.ddev.site/api/health"
curl "https://websitebase.ddev.site/api/public/v1/docs/ui"

Authentifizierung & Zugriff

Je API können unterschiedliche Auth-Modi genutzt werden: public, token, user, backend. Für geschützte Endpunkte werden Scopes und optional ein echter User-Kontext erzwungen.

# Public endpoint
curl "https://websitebase.ddev.site/api/health"

# Swagger-Doku für API-Consumer
curl "https://websitebase.ddev.site/api/public/v1/docs.json"

Best Practices

  • Scopes pro Endpoint so eng wie möglich halten.
  • Query/Path/Body-Parameter immer per Attribute validieren.
  • Für read-heavy Endpunkte Caching mit Tags aktivieren.
  • OpenAPI als Single Source of Truth für Integrationen verwenden.
  • Request IDs und strukturierte Logs für Support und Betrieb nutzen.