Back

Dein erstes CRUD-API

30 Minuten ANFÄNGER

Baue deine erste REST-API mit Create-, Read-, Update- und Delete-Operationen. Lerne die Grundlagen der GEMVC-4-Schichten-Architektur Schritt für Schritt.

What You'll Learn

API-Service-Schicht

URL-Endpunkte anlegen und Anfragen validieren

Controller-Schicht

Geschäftslogik orchestrieren

Model- & Table-Schichten

Datenlogik und Datenbankoperationen

Video tutorial thumbnail
Watch Tutorial

Die 4-Schichten-Architektur verstehen

GEMVC nutzt ein klares 4-Schichten-Architekturmuster. Jede Schicht hat eine klare Aufgabe.
Jede Anfrage wird nach dem Eintreffen beim Webserver vom Bootstrap verarbeitet. Er führt folgende Schritte aus:

  1. 1. Alle Header bereinigen
  2. 2. Alle Anfragedaten bereinigen
  3. 3. Dateien, Cookies und Auth-Header extrahieren
  4. 4. Einheitliches Request-Objekt erzeugen
  5. 5. Anfrage an die API-Service-Schicht weiterleiten
  6. 6. Request-Objekt in die API-Service-Schicht injizieren

und der Ablauf geht von oben nach unten:

API-Schicht
↓
Controller-Schicht
↓
Model-Schicht
↓
Table-Schicht

Folge den Anleitungen unten, um jede Schicht zu erstellen und eine vollständige CRUD-API zu bauen.

CLI-Befehle

Vollständiges CRUD für einen Service erstellen

Dieser Befehl erstellt alle 4 Schichten der CRUD-API: Api, Controller, Model und Table aus dem angegebenen ServiceName.

Terminal 
php vendor/bin/gemvc create:crud ServiceName

Beispiel: php vendor/bin/gemvc create:crud Company

Dieser Befehl erstellt bei unserem Beispiel „Company“ folgende Dateien:

  • app/api/Company.php
  • app/controller/CompanyController.php
  • app/model/CompanyModel.php
  • app/table/CompanyTable.php

Table-Schicht-Klasse in die Datenbank migrieren

Dieser Befehl migriert die Table-Schicht-Klasse in die Datenbank.

Terminal 
php vendor/bin/gemvc db:migrate TableClassName

Beispiel: php vendor/bin/gemvc db:migrate CompanyTable

Erstellte Tabelle in der Datenbank prüfen

Das Schema der erstellten Tabelle kannst du mit folgendem Befehl prüfen:
Hinweis: tableName ist der Zeichenkettenname, der in der Methode getTable() der Table-Schicht-Klasse definiert ist.

Terminal 
php vendor/bin/gemvc db:describe tableName

Beispiel: php vendor/bin/gemvc db:describe companies

Beispiel: Ablauf einer Anfrage

So fließt eine Anfrage durch alle 4 Schichten:

1
API-Service
POST /api/User/create → Validiert Schema → Ruft Controller auf
2
Controller
Mappt POST-Daten auf Model → Ruft Model-Methode auf
3
Model
Validiert Geschäftsregeln → Transformiert Daten → Ruft Table auf
4
Table
Führt Datenbankabfrage aus → Gibt Daten zurück → Antwort fließt nach oben
Tip: Rufe localhost/api/index/document auf, um die automatisch erzeugte API-Dokumentation zu sehen. Klicke auf „Export to Postman“, um die Postman-Collection zum Testen deiner API zu erhalten.
1

Vertiefung: API-Service-Schicht

Schicht 1: API-Endpunkte

Die API-Service-Schicht ist der Einstiegspunkt für alle HTTP-Anfragen. Sie kümmert sich um URL-Endpunkte, Anfragevalidierung und Authentifizierung, bevor sie an die Controller-Schicht weitergibt.

Aufgaben:

  • • Request-Schemas definieren (definePostSchema(), defineGetSchema())
  • • Authentifizierung ($request->auth())
  • • Eingehende Daten validieren
  • • An Controller-Schicht weiterleiten
Vertiefung: API-Service-Schicht
2

Vertiefung: Controller-Schicht

Schicht 2: Orchestrierung der Geschäftslogik

Die Controller-Schicht orchestriert die Geschäftslogik und koordiniert die Models. Sie mappt Anfragedaten auf Models und steuert den Request-/Response-Fluss.

Aufgaben:

  • • Ablauf der Geschäftslogik orchestrieren
  • • Anfragedaten auf Models mappen (mapPostToObject())
  • • Bei Bedarf mehrere Models koordinieren
  • • Request-/Response-Fluss steuern
  • • An Model-Schicht weiterleiten
Controller erstellen
3

Vertiefung: Model-Schicht

Schicht 3: Datenlogik & Validierungen

Die Model-Schicht enthält Geschäftsvalidierungen, Datentransformationen und Fehlerbehandlung. Sie erweitert die Table-Schicht und fügt Geschäftslogik über den Datenbankoperationen hinzu.

Aufgaben:

  • • Geschäftsvalidierungen (z. B. doppelte E-Mail prüfen)
  • • Datentransformationen (z. B. Passwort-Hashing)
  • • Fehlerbehandlung und Response-Formatierung
  • • Nutzt Table-Schicht-Methoden für Datenbankoperationen
  • • Gibt JsonResponse-Objekte zurück
Model erstellen
4

Vertiefung: Table-Schicht

Schicht 4: Datenbankzugriff & Abfragen

Die Table-Schicht stellt Datenbankzugriff, Abfragemethoden und Schema-Definition bereit. Sie definiert die Tabellenstruktur und bietet eine fluente Query-Builder-Schnittstelle.

Aufgaben:

  • • Datenbanktabellenstruktur definieren
  • • Eigenschaften zu Spalten zuordnen
  • • Abfragemethoden bereitstellen (selectById(), selectByEmail())
  • • Fluent Query Builder nutzen (select()->where()->limit()->run())
  • • Schema-Constraints definieren (Indizes, Unique Keys)
Table erstellen

🚀 Bereit für deine erste API?

Starte mit der API-Service-Schicht und arbeite dich über Controller, Model und Table vor. Folge jeder Anleitung, um eine vollständige CRUD-API zu bauen!

Start: Vertiefung API-Service-Schicht Zurück zur Lernübersicht Technische Doku ansehen