laravel_elasticsearch_scout

Laravel 11 Elasticsearch 8 API с репозиторием и схемой обслуживания

Этот проект демонстрирует, как интегрировать Elasticsearch 8 в приложение Laravel 11, используя репозиторий и шаблон обслуживания для чистой и поддержанной архитектуры. Он демонстрирует создание RESTFUL API, который использует ElasticSearch для мощных возможностей поиска.

Функции

• Laravel 11 и Elasticsearch 8: использует последние версии обеих рамок.
• Репозиторий и шаблон обслуживания: продвигает организацию кода, разделение проблем и тестируемость.
• RESTFUL API: предоставляет конечные точки для взаимодействия с данными, питаемые от Elasticsearch.
• Запрошенная черта: предлагает многоразовое решение для применения сложных фильтров к красноречивым моделям в репозиториях.
• Автоматические обновления индекса: использует пакеты babenkoivan/elastic-scout-driver и babenkoivan/elastic-scout-driver-plus чтобы гарантировать, что индексы Elasticsearch автоматически обновляются при создании, обновленных или удаленных моделях.

Установка

1. Клонировать репозиторий:

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

2. Установить зависимости композитора:

   composer install

3. Настройка среды:
   • Скопировать .env.example to .env и обновить базу данных и учетные данные Elasticsearch.
   • Установите детали подключения Elasticsearch в файле config/elastic.php .
4. Генерировать ключ приложения:

   php artisan key:generate

5. Запустите миграции и сеялки (необязательно):

   php artisan migrate --seed 

Использование

1. Start Elasticsearch: см. Документацию Elasticsearch, чтобы запустить сервер Elasticsearch.
2. Индексировать свои данные: используйте предоставленные команды ремесленника или программно индексируйте ваши модели в Elasticsearch.
3. Исследуйте API: приложение будет выставлять конечные точки API для поиска, фильтрации и взаимодействия с вашими данными. Обратитесь к документации API для конкретных конечных точек и примеров использования.

Структура проекта

 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

Ключевые технологии

• PHP 8.1+
• Ларавел 11
• Elasticsearch 8
• Babenkoivan/Elastic-Scout Driver
• Babenkoivan/Elastic-Scout-Driver-Plus

Внося

Не стесняйтесь внести свой вклад в этот проект, отправив вопросы или обращайте запросов.

Лицензия

Этот проект лицензирован по лицензии MIT.