Laravel Resource – Kurz mal erklärt

Nutzen wir zum Beispiel Larvel als Backend und beliefern das Frontend via api Route mit Daten, dann stellt sich manchmal die Frage, welche Daten braucht das Frontend eigentlich? Braucht man wirklich created_at oder updated_at mit auszuliefern?

Sobald man sich so eine oder ähnliche Frage stellt wird es Zeit sich mal mit Laravel Resource auseinander zu setzen. Ich nehme mal stark an, dass wenn ihr diese Zeilen ließt, über die Suchmaschine auf diesen Text gestoßen seid. Also habt ihr euch die Frage mit Sicherheit vor kurzem erst gestellt.

Lange Rede und kein Sinn. Gehen wir mal über zum praktischem Teil. Wir wollen einer Api anfrage nur bestimmte Felder mitliefern. Klassisches Beispiel, wir haben ein Blog. Und im Listing brauchen wir eigentlich nur: Title, Slug, Teaser.

Im Api/PostController unter der index() Funktion steht erstmal nur:

public function index() {
 return Post::all();
} 

Um nur die oben genannten Felder auszuliefern, benötigen wir ein PostResource Klasse. Die erstellen wir mit artisan in der Kommandozeile.

php artisan make:resource PostResource 

Artisan legt mit diesem Befehl eine Datei unter app/Http/Resources ab. Und zwar die PostResource.php. Diese hat eine öffentliche Funktion toArray($request). In der löschen wir die aktuelle Rückgabe : parent::toArray($request); und schreiben ein Array mit den gewünschten Felder die wir dann returnen wollen.

return [
  ‘id‘ => $this→id,
 ‘title‘ => $this→title,
  ‘slug‘ => $this→slug,
 ‘teaser‘ => \Illuminate\Support\Str::limit($this→content, 20),
]; 

Das $this ist das aktuelle PostModel.

Nun wechseln wir wieder in unseren PostController und schreiben die aktuelle index Funktion um.

public function index() {
  return PostResource::collection(Post::all());
}

And viola!


Leave a Comment

Your email address will not be published. Required fields are marked *

*

*

Empfholende Artikel


Meine wichtigsten Artisan Commands

September 6, 2021

Als Laravel Entwickler braucht man sie ständig. Wenn man etwas länger Frontendarbeiten gemacht hat, kommt es schon mal vor, dass man etwas vergessen hat. Daher hier die Liste mit den häufigsten Artisan Commands: php artisan migrate:rollback –step=1 Ihr wollte eine oder x-beliebige Migrationen zurückspulen? Dann rollback und die Anzahl der Migrationssteps eingeben. php artisan migrate:refresh […]

Laravel – Slugs einrichten

September 2, 2021

Slugs machen die URLs Sprechender und damit auch SEO-(Freund)licher. Statt domain.de/posts/1 würde man mit domain.de/posts/mein-erster-blog-eintrag arbeiten. Um das in Laravel zu realisieren, bedient man sich in der Regel externer Bibliotheken. Einmal eine von Spartie und eine cviebrock. Man kann es natürlich aber auch selber machen. Die Bibliotheken sind hier aber vorzuziehen. Weil es ist keine […]

Laravel Blade Components

August 27, 2021

Componets – Aus VueJS kennen wir es und haben es bereits lieben gelernt. In Laravel können wir im Blade auch sehr dynamisch in Componenten arbeiten. Von Hause gibt uns Laravel Componets mit. Am Beispiel erklärt Stellen wir uns vor, wir wollen ein Blog erstellen. In der Übersichtsseite, sollen die Blogartikel untereinander gelistet werden. Wer ohne […]

Laravel Spatie Permission Package – Kurz mal erklärt

August 25, 2021

Die belgische „SoftwareGang“ Spatie haut ein coole Laravel Package nach dem anderen raus. Super nützlich und sehr angenehm zu nutzen. Heute gibt es einen Einstieg in das Package Spatie Permission Package. I. Einrichten 1. Schritt: 2. Schritt: Permission Service Provider anmelden Füge dafür den „PermissionServiceProvider“ in der Datei config/app.php ein. 3. Schritt: Kopiere die migration […]

Laravel Test möglicher Fehler – Unknown formatter “name”

April 17, 2021

Falls Du gerade Dein Test geschrieben hast und du deinen Test mit php artisan test startest kann es sein, dass Du folgende Fehlermeldung erhalten kannst: Was ist passiert? Wahrscheinlich hast Du in deiner seUp() Methode oder in deiner Testfunktion ein factory eingebaut. Zum Beispiel Da Laravel einige Optimierungen vorgenommen hat, kannst Du nicht die Standard […]

Eine einzelne Migration in Laravel ausführen

March 25, 2021

Aus unterschiedlichen Gründen kann es sein, dass man in einem Laravel Projekt eine spezielle Migration ausführen möchte. Zum Beispiel die zuletzt erstellte Migration. Ein anscheinend häufiger Grund für dieses Vorgehen könnte sein, dass in einer vorherigen Migrationsdatei ein Fehler auftreten würde. Und da Laravel die Migrationsdateien von der ältestesten zur jüngsten Migration abarbeitet, würde man […]