Erstellen Sie ein neues Laravel -Projekt und starten Sie den Service. 2. Generieren Sie das Modell, die Migration und den Controller und führen Sie die Migration aus; 3. Definieren Sie die erholsame Route in Routen/api.php; V. 5. Testen Sie die API -Funktionalit?t mit Postmann oder Curl; 6. Fügen Sie optional die API -Authentifizierung durch Heiligtum hinzu; Erhalten Sie schlie?lich eine klare Struktur, vollst?ndige und erweiterbare Laravel -REST -API, die für praktische Anwendungen geeignet ist.

Der Aufbau einer REST-API mit Laravel ist dank der integrierten Funktionen für Routing, eloquentes ORM und Anfragebedingung unkompliziert. Hier ist ein praktischer Leitfaden, mit dem Sie mit Laravel eine saubere, funktionale REST -API erstellen k?nnen.

1. Richten Sie ein neues Laravel -Projekt ein

Erstellen Sie mit dem Komponisten ein neues Laravel -Projekt:

 Komponist erstellen projekt-projekt laravel/laravel api-Demo
CD-API-Demo

Starten Sie dann den Entwicklungsserver, um zu best?tigen, dass alles funktioniert:

 PHP Artisan Serve

Sie sollten die Laravel -Begrü?ungsseite unter http://localhost:8000 sehen.

2. Erstellen Sie ein Modell, eine Migration und ein Controller

Erstellen wir eine einfache API für die Verwaltung von Beitr?gen . Verwenden Sie den Befehl make:model mit dem -a flag, um ein Modell, eine Migration, Fabrik und einen Controller zu generieren:

 Php Artisan Make: Model Post -a

Dies schafft:

• app/Models/Post.php - Das eloquente Modell
• database/migrations/xxxx_create_posts_table.php - Die Migration
• app/Http/Controllers/PostController.php - der Controller
• database/factories/PostFactory.php - zum Sehen

Bearbeiten Sie die Migrationsdatei, um die Postfelder zu definieren:

 // in Datenbank/Migrationen /..._ create_posts_table.php
Schema :: Create ('Beitr?ge', Funktion (Blueprint $ Tabelle) {
    $ table-> id ();
    $ table-> string ('title');
    $ table-> text ('K?rper');
    $ table-> timestemps ();
});

Führen Sie die Migration aus:

 PHP Artisan migrieren

3. Definieren Sie API -Routen

?ffnen Sie routes/api.php und definieren Sie erholsame Routen mit Route::apiResource() :

 Verwenden Sie App \ http \ controller \ postcontroller;

Route :: apireSource ('Beitr?ge', postcontroller :: class);

Diese Routen karten automatisch Standard -REST -Aktionen:

• GET /api/posts → Index
• POST /api/posts → Speichern
• GET /api/posts/{id} → anzeigen
• PUT/PATCH /api/posts/{id} → aktualisieren
• DELETE /api/posts/{id} → zerst?ren

Sie k?nnen alle Routen mit:

 PHP Artisan Route: Liste -Path = API

4. Implementieren Sie die Controller -Methoden

?ffnen Sie app/Http/Controllers/PostController.php und füllen Sie die Logik mit eloquent aus.

 Verwenden Sie App \ Models \ post;
Verwenden Sie Illuminate \ http \ request;

Der Nachontroller der Klasse erweitert den Controller
{
    ?ffentlicher Funktionsindex ()
    {
        return response ()-> json (post :: all ());
    }

    ?ffentlicher Funktionsgesch?ft (Anfrage $ Anfrage)
    {
        $ validated = $ request-> validate ([
            'Titel' => 'Erforderlich | String | max: 255',
            'K?rper' => 'Erforderlich | String',
        ]);

        $ post = post :: create ($ validiert);

        return response ()-> json ($ post, 201);
    }

    ?ffentliche Funktionshow ($ id)
    {
        $ post = post :: find ($ id);

        if (! $ post) {
            return response ()-> json (['message' => 'post nicht gefunden'], 404);
        }

        return response ()-> json ($ post);
    }

    ?ffentliche Funktion Update (Anfrage $ Anfrage, $ ID)
    {
        $ post = post :: find ($ id);

        if (! $ post) {
            return response ()-> json (['message' => 'post nicht gefunden'], 404);
        }

        $ validated = $ request-> validate ([
            'Titel' => 'Erforderlich | String | max: 255',
            'K?rper' => 'Erforderlich | String',
        ]);

        $ post-> update ($ validiert);

        return response ()-> json ($ post);
    }

    ?ffentliche Funktion Zerst?rung ($ id)
    {
        $ post = post :: find ($ id);

        if (! $ post) {
            return response ()-> json (['message' => 'post nicht gefunden'], 404);
        }

        $ post-> delete ();

        return response ()-> json (['message' => 'post gel?scht']);
    }
}

? Laravel gibt automatisch JSON-Antworten zurück, wenn Sie Daten an response()->json() übergeben. Au?erdem werden API -Routen bereits durch CSRF -Nachweise geschützt und verwenden die api Middleware (staatenlos).

5. Testen Sie die API

Verwenden Sie ein Tool wie Postman- , Curl- oder Thunder -Client (VS -Code), um Ihre Endpunkte zu testen.

Beispiel: Erstellen Sie einen Beitrag mit Curl

 curl -x post http: // localhost: 8000/api/posts \
  -H "Inhaltstyp: application/json" \
  -D '{"Titel": "Mein erster Beitrag", "K?rper": "Dies ist der K?rper"} "

Sie sollten eine JSON -Antwort mit dem erstellten Beitrag und einen 201 -Status erhalten.

6. (optional) Fügen Sie die API -Authentifizierung mit Sanctum hinzu

Verwenden Sie für geschützte Routen Laravel Sanctum, um eine tokenbasierte Authentifizierung hinzuzufügen.

Sanctum installieren:

 Der Komponist ben?tigt Laravel/Sanctum
PHP Artisan Vendor: Publish -Provider = "Laravel \ Sanctum \ SanctumServiceProvider"
PHP Artisan migrieren

Fügen Sie die Sanctum Middleware in app/Http/Kernel.php unter 'api' hinzu:

 'api' => [
    \ Laravel \ Sanctum \ http \ Middleware \ scheffeFrontendRequestSarestatul :: Klasse,
    'Drosselklappen: API',
    \ Illuminate \ Routing \ Middleware \ Ersatzbindungen :: Klasse,
],

Schützen Sie Ihre Strecken:

 Route :: Middleware ('Auth: Sanctum')-> apireSource ('Beitr?ge', postcontroller :: class);

Jetzt müssen Benutzer sich mit einem Token authentifizieren, um auf die API zuzugreifen.

Letzte Notizen

• Halten Sie die Validierungslogik sauber - Berücksichtigen Sie mit Formularanfragen für komplexe Regeln.
• Verwenden Sie API -Ressourcen ( php artisan make:resource PostResource ), um Antworten zu formatieren.
• Gehen Sie immer anmutig mit Fehlern um (zB 404, 422).
• Verwenden Sie die Versionierung (z. /api/v1/posts ) für langfristige Stabilit?t.

Das war's. Sie haben jetzt eine voll funktionsf?hige REST -API mit Laravel. Es ist sauber, skalierbar und bereit für die reale Verwendung.

Das obige ist der detaillierte Inhalt vonWie baue ich eine REST -API mit Laravel?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!