laravel_elasticsearch_scout

Laravel 11 Elasticsearch 8 API com repositório e padrão de serviço

Este projeto demonstra como integrar o Elasticsearch 8 em um aplicativo Laravel 11 usando o repositório e o padrão de serviço para uma arquitetura limpa e sustentável. Ele mostra a criação de uma API RESTful que aproveita o Elasticsearch para obter recursos de pesquisa poderosos.

Características

• Laravel 11 e Elasticsearch 8: utiliza as versões mais recentes de ambas as estruturas.
• Repositório e padrão de serviço: promove a organização do código, a separação de preocupações e a testabilidade.
• API RESTful: fornece pontos de extremidade para interagir com dados, alimentados pelo Elasticsearch.
• Traço consultável: oferece uma solução reutilizável para aplicar filtros complexos a modelos eloquentes nos repositórios.
• Atualizações do índice automático: aproveita os pacotes babenkoivan/elastic-scout-driver e babenkoivan/elastic-scout-driver-plus para garantir que os índices Elasticsearch sejam atualizados automaticamente quando os modelos são criados, atualizados ou excluídos.

Instalação

1. Clone o repositório:

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

2. Instale dependências do compositor:

   composer install

3. Configurar o ambiente:
   • Copy .env.example para .env e atualize o banco de dados e as credenciais do Elasticsearch.
   • Configure seus detalhes de conexão Elasticsearch no arquivo config/elastic.php .
4. Gere a chave do aplicativo:

   php artisan key:generate

5. Execute migrações e semeadores (opcional):

   php artisan migrate --seed 

Uso

1. Iniciar o Elasticsearch: consulte a documentação do Elasticsearch para iniciar seu servidor Elasticsearch.
2. Indique seus dados: use os comandos artesanais fornecidos ou indexe programaticamente seus modelos no Elasticsearch.
3. Explore a API: o aplicativo exporá pontos de extremidade da API para pesquisar, filtrar e interagir com seus dados. Consulte a documentação da API para pontos de extremidade específicos e exemplos de uso.

Estrutura do projeto

 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

Tecnologias -chave

• Php 8.1+
• Laravel 11
• Elasticsearch 8
• Babenkoivan/elástico-scout-driver
• Babenkoivan/elástico-scout-driver-plus

Contribuindo

Sinta -se à vontade para contribuir com este projeto enviando questões ou solicitações.

Licença

Este projeto está licenciado sob a licença do MIT.