Skip to content

docs(elasticsearch): compatibility with laravel and improve #2092

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 9, 2024
Merged

docs(elasticsearch): compatibility with laravel and improve #2092

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 30 additions & 7 deletions core/elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ To enable the reading support for Elasticsearch, simply require the Elasticsearc
composer require elasticsearch/elasticsearch:^7.11
```

Then, enable it inside the API Platform configuration:
Then, enable it inside the API Platform configuration, using one of the configurations below:

### Enabling Reading Support using Symfony

```yaml
# api/config/packages/api_platform.yaml
Expand All @@ -38,12 +40,32 @@ api_platform:
#...
```

### Enabling Reading Support using Laravel

```php
<?php
// config/api-platform.php
return [
// ....
'mapping' => [
'paths' => [
base_path('app/Models'),
],
],
'elasticsearch' => [
'hosts' => [
env('ELASTICSEARCH_HOST', 'http://localhost:9200'),
],
],
];
```

## Creating Models

API Platform follows the best practices of Elasticsearch:

- a single index per resource should be used because Elasticsearch is going to [drop support for index types and will allow only a single type per
index](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html);
- a single index per resource should be used because Elasticsearch is going to [drop support for index types and will
allow only a single type per index](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html);
- index name should be the short resource name in lower snake_case;
- the default `_doc` type should be used;
- all fields should be lower case and should use camelCase for combining words.
Expand Down Expand Up @@ -143,7 +165,7 @@ Here is an example of mappings for 2 resources, `User` and `Tweet`, and their mo

```php
<?php
// api/src/Model/User.php
// api/src/Model/User.php with Symfony or app/Model/User.php with Laravel
namespace App\Model;

use ApiPlatform\Elasticsearch\State\CollectionProvider;
Expand Down Expand Up @@ -182,7 +204,7 @@ class User

```php
<?php
// api/src/Model/Tweet.php
// api/src/Model/Tweet.php with Symfony or app/Model/Tweet.php with Laravel
namespace App\Model;

use ApiPlatform\Elasticsearch\State\CollectionProvider;
Expand Down Expand Up @@ -223,8 +245,9 @@ You're done! The API is now ready to use.

## Filtering

See how to use Elasticsearch filters and how to create Elasticsearch custom filters in [the Filters chapter](filters.md).
See how to use Elasticsearch filters and how to create Elasticsearch custom filters in the
[Elasticsearch filters documentation](../core/elasticsearch-filters.md).

## Creating Custom Extensions

See how to create Elasticsearch custom extensions in [the Extensions chapter](extensions.md).
See how to create Elasticsearch custom extensions in [the Extensions chapter](extensions.md#custom-elasticsearch-extension).
Loading