A package to build quick and robust rest api for the Laravel framework.
lomkit/laravel-rest-api is a Laravel package for a package to build quick and robust rest api for the laravel framework..
It currently has 599 GitHub stars and 67.830 downloads on Packagist (latest version v2.23.1).
Install it with composer require lomkit/laravel-rest-api.
Discover more Laravel packages by lomkit
or browse all Laravel packages to compare alternatives.
Last updated
Laravel Rest Api is an elegant way to expose your app through an API, it takes full advantage of the Laravel ecosystem such as Policies, Controllers, Eloquent, ...
PHP 8.2+ and Laravel 12+
See the documentation for detailed installation and usage instructions.
You'll find multiple endpoints exposed when using this package such as mutating, searching, showing, deleting, ...
Here is a quick look at what you can do using API search method:
// POST api/posts/search
{
"search": {
"scopes": [
{"name": "withTrashed", "parameters": [true]}
],
"filters": [
{
"field": "id", "operator": ">", "value": 1, "type": "or"
},
{
"nested": [
{"field": "user.posts.id", "operator": "<", "value": 2},
{"field": "user.id", "operator": ">", "value": 3, "type": "or"}
]
}
],
"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" }
]
}
],
"gates": ["create", "view"],
"page": 2,
"limit": 10
}
}
