News

Laravel Rest Api now supports Laravel Scout

Published
Laravel Rest Api now supports Laravel Scout image

With the latest release of Laravel Rest Api, the quick and easy way to manage your Api in Laravel, a native integration of Laravel Scout has been released.

Now, just by specifying "search.text.value" in your search, you are able to make a full text search from your front-end side:

// (POST) api/posts/search
{
    "text": {
        "value": "my full text search"
    }
}

Fully integrates with other Laravel Rest Api features

By using full text search you have some small limitations on the arguments you can provide but this doesn`t restrict other features which allow you to perform the following query :

// (POST) api/posts/search
{
    "text": {
        "value": "my full text search"
    },
    "filters": [
        {
            "field": "type", "operator": "=", "value": "romance"
        }
    ],
    "sorts": [
        {"field": "user_id", "direction": "desc"},
        {"field": "id", "direction": "asc"}
    ],
    "selects": [
        {"field": "id"}
    ],
    "includes": [
        {
            "relation": "posts",
            "filters": [
                 {"field": "id", "operator": "in", "value": [1, 3]}
            ],
            "limit": 2
        },
        {
            "relation": "user",
            "filters": [
                {
                    "field": "languages.pivot.boolean",
                    "operator": "=",
                    "value": true
                }
            ]
        }
    ],
    "aggregates": [
        {
            "relation": "stars",
            "type": "max",
            "field": "rate",
            "filters": [
                {"field": "approved", "value": true}
            ]
        }
    ],
    "instructions": [
      {
        "name": "odd-even-id",
        "fields": [
          { "name": "type", "value": "odd" }
        ]
      }
    ],
    "page": 2,
    "limit": 10
}

Links

The Laravel Rest Api package and documentation can be found on GitHub at lomkit/laravel-rest-api.

Gautier Deleglise photo

Passionate Laravel dev dedicated to helping enhancing the Laravel ecosystem for a seamless developer experience. 🚀

Filed in

Sponsored

laravelcloud logo
Laravel Cloud

Easily create and manage your servers and deploy your Laravel applications in seconds.

Visit Laravel Cloud

The latest

View all →
Email Sending and Testing for Laravel in One Account image

Email Sending and Testing for Laravel in One Account

Read article
Decide with Jev: Tie Every AI Check to the Exact Draft image

Decide with Jev: Tie Every AI Check to the Exact Draft

Read article
PIE 1.5 Changes PHP Extension Installs in CI image

PIE 1.5 Changes PHP Extension Installs in CI

Read article
Delete Expired Sessions in Laravel With a Scheduled Command image

Delete Expired Sessions in Laravel With a Scheduled Command

Read article
Pollora: Run WordPress Inside a Laravel Application image

Pollora: Run WordPress Inside a Laravel Application

Read article
Scheduled Session Garbage Collection in Laravel 13.39 image

Scheduled Session Garbage Collection in Laravel 13.39

Read article