Wie fusioniere ich eine Laravel -API?

Verwenden Sie die URL -Versioning (z. B. /API /V1) für Einfachheit und Klarheit. 2. Gruppenversionierte Routen mit Route :: Präfix () in Routen/api.php. 3. organisieren Controller, Ressourcen und Transformatoren nach Version in separaten Verzeichnissen (z. B. App \ http \ Controller \ api \ v1). 4. Verwenden Sie Laravel -API -Ressourcen, um konsistente Antwortstrukturen pro Version aufrechtzuerhalten. 5. Verwenden Sie optional Header-basierte Versioning mit Middleware, obwohl dies Komplexität erhöht. 6. Aktivieren Sie alte Versionen anmutig, indem Sie Warnscheiben hinzufügen, die Nutzung abgeben, Zeitpläne kommunizieren und nur dann entfernen, wenn sie sicher sind. Die frühe Versionierung sorgt für die Rückwärtskompatibilität und verhindert, dass die Kunden unerwartet gebrochen werden.

Das Versioning einer Laravel -API ist eine bewährte Methode, um die Rückwärtskompatibilität beizubehalten, wenn Sie Bruchänderungen vornehmen. Hier erfahren Sie, wie Sie es effektiv und sauber machen können.

1. Verwenden Sie URL- oder Headerversioning (URL ist einfacher)

Der häufigste und unkomplizierteste Ansatz ist die URL -Versioning , bei der die API -Version Teil der Route ist:

 /api/v1/Benutzer
/API/V2/Benutzer

Definieren Sie in Laravel versionierte Routen in routes/api.php :

 // Routes/api.php

// v1 Endpunkte
Route :: Präfix ('v1')-> Gruppe (function () {
    Route :: apireSource ('Benutzer', [v1 \ usercontroller :: class]);
});

// v2 Endpunkte
Route :: Präfix ('v2')-> Gruppe (function () {
    Route :: apireSource ('Benutzer', [v2 \ usercontroller :: class]);
});

Dies hält die Routen isoliert und macht deutlich, welche Version ein Client verwendet.

✅ Tipp : Verwenden Sie bei Bedarf Routenpräfixe mit Middleware (z. B. Auth, Drosselung).

2. organisieren Sie Controller und Ressourcen nach der Version

Strukturieren Sie Ihre App, um mehrere Versionen sauber zu unterstützen:

 App/
└── http/
    └── Controller/
        └── API/
            ├── v1/
            │ ├── UserController.php
            │ └── Transformers/
            └── v2/
                ├── UserController.php
                └── Transformatoren/

Jede Version verfügt über eigene Controller, Anforderungsklassen und Ressourcentransformatoren (bei Verwendung von API -Ressourcen).

Zum Beispiel:

 // app \ http \ controller \ api \ v1 \ usercontroller.php
Namespace App \ http \ Controller \ api \ v1;

Klasse UserController erweitert den Controller
{
    öffentlicher Funktionsindex ()
     {
         userresource :: collection zurückgeben (user :: all ());
     }
}

 // app \ http \ controller \ api \ v2 \ usercontroller.php
Namespace App \ http \ Controller \ api \ v2;

Klasse UserController erweitert den Controller
{
    öffentlicher Funktionsindex ()
    {
        userv2Resource :: collection (user :: mit ('profil')-> get ());
    }
}

3. Verwenden Sie API -Ressourcen für die Reaktionskonsistenz

Die API -Ressourcen von Laravel helfen, Reaktionen pro Version konsequent zu formatieren:

 PHP Artisan Make: Ressourcen v1/usserresource
Php Artisan Make: Ressourcen V2/Userv2Resource

Auch wenn sich die zugrunde liegenden Daten ändert, gibt jede Version die erwartete Struktur zurück.

4. Optional: Headerbasierte Versioning

Einige bevorzugen Versionungen über Header (z. B. Accept: application/vnd.myapp.v2 json ). Während Puristen "erholsamer" sind, ist es schwieriger zu testen und zu debuggen.

Wenn Sie diese Route gehen, inspizieren Sie den Header Accept und Route entsprechend - dies fügt jedoch Komplexität hinzu. Für die meisten Apps ist die URL -Versionierung klarer und leichter zu verwalten .

5. Die alten Versionen anmutig machen

Beim Ruhestand einer Version:

• Fügen Sie Deprecated Header hinzu
• Protokollverwendung alter Versionen
• API -Verbrauchern Zeitpläne vermitteln
• Entfernen Sie schließlich Routen/Controller, wenn Sie sicher sind

Beispiel Middleware, um veraltete Versionen zu markieren:

 // app/http/Middleware/Checkapiversion.php
Öffentliche Funktion Handle ($ Anfrage, $ Weitere, $ Version)
{
    if ($ Version === 'v1') {
        Header ('X-API-deprecated: true');
        Header ('X-API-WARN: V1 wird am 2025-01-01' veraltet sein);
    }

    Rückgabe $ als nächstes ($ request);
}

Wenden Sie es in Ihrer Routengruppe an:

 Route :: Präfix ('v1')-> Middleware ('check.api.version: v1')-> Gruppe (Funktion () {{
    // ...
});

Zusammenfassung

• ✅ URL -Versioning verwenden ( /api/v1/... )
• ✅ Gruppenrouten mit prefix('v1')
• ✅ Separate Controller und Ressourcen pro Version
• ✅ Reaktionsformate stabil halten
• ✅ alte Versionen mit Warnungen abbauen

Es ist nicht auffällig, aber zuverlässig und leicht zu skalieren. Die erfolgreichsten APIs (Stripe, Github usw.) verwenden ähnliche Muster.

Grundsätzlich: Version früh, Version klar und brechen Sie die Kunden nicht unerwartet.

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