laravel_elasticsearch_scout

Laravel 11 Elasticsearch 8 API mit Repository und Servicemuster

Dieses Projekt zeigt, wie Elasticsearch 8 in eine Laravel 11 -Anwendung mit dem Repository- und Service -Muster für eine saubere und wartbare Architektur integriert wird. Es zeigt eine erholsame API, die Elasticsearch für leistungsstarke Suchfunktionen nutzt.

Merkmale

• Laravel 11 und Elasticsearch 8: Verwendet die neuesten Versionen beider Frameworks.
• Repository und Servicemuster: Fördert die Codeorganisation, die Trennung von Bedenken und Testbarkeit.
• RESTFOR API: Bietet Endpunkte für die Interaktion mit Daten, die von ElasticSearch betrieben werden.
• Abfragbares Merkmal: bietet eine wiederverwendbare Lösung für die Anwendung komplexer Filter auf eloquente Modelle innerhalb von Repositories.
• Automatische Index-Updates: Nutzt die Pakete babenkoivan/elastic-scout-driver und babenkoivan/elastic-scout-driver-plus um sicherzustellen, dass Elasticsearch-Indizes automatisch aktualisiert werden, wenn Modelle erstellt, aktualisiert oder gelöscht werden.

Installation

1. Klonen Sie das Repository:

   git clone https://github.com/ninhhuynh1999/laravel_elasticsearch_books.git

2. Installieren Sie die Abhängigkeiten der Komponisten:

   composer install

3. Umgebung konfigurieren:
   • Kopieren Sie .env.example in .env und aktualisieren Sie Datenbank- und Elasticsearch -Anmeldeinformationen.
   • Richten Sie Ihre Elasticsearch -Verbindungsdetails in der Datei config/elastic.php ein.
4. Anwendungsschlüssel generieren:

   php artisan key:generate

5. Migrationen und Sämaschinen ausführen (optional):

   php artisan migrate --seed 

Verwendung

1. Starten Sie ElasticSearch: Siehe Dokumentation von Elasticsearch, um Ihren ElasticSearch -Server zu starten.
2. INDEN SIE IHRE Daten: Verwenden Sie die bereitgestellten Artisan -Befehle oder indizieren Sie Ihre Modelle programmgesteuert in Elasticsarch.
3. Erforschen Sie die API: Die Anwendung wird API -Endpunkte für die Suche, Filtern und Interaktion mit Ihren Daten ausgesetzt. In der API -Dokumentation finden Sie bestimmte Endpunkte und Verwendungsbeispiele.

Projektstruktur

 app/
├── Classes/       // DTOs (Data Transfer Objects), Request Filters, etc. 
├── Models/         // Eloquent models
├── Repositories/    // Repository interfaces and implementations
├── Services/        // Service interfaces and implementations
├── Traits/          // Reusable traits, including the "Queryable" trait
routes/
    api.php       // API routes

Schlüsseltechnologien

• PHP 8.1+
• Laravel 11
• Elasticsearch 8
• Billenkoivan/Elastizierstreiber
• Billenkoivan/Elastic-Scout-Fahrer-Plus

Beitragen

Fühlen Sie sich frei, zu diesem Projekt beizutragen, indem Sie Probleme einreichen oder Anfragen ziehen.

Lizenz

Dieses Projekt ist unter der MIT -Lizenz lizenziert.