lomkit/laravel-rest-api
A package to build quick and robust rest api for the Laravel framework.
Maintainers
Fund package maintenance!
v2.21.3
2026-06-02 19:56 UTC
Requires
- php: ^8.2
- ext-json: *
- laravel/framework: ^11|^12|^13
Requires (Dev)
- guzzlehttp/guzzle: ^6.0|^7.0
- laravel/scout: ^10|^11
- orchestra/testbench: ^9|^10|^11
- phpunit/phpunit: ^10|^11|^12|^13
Suggests
- dedoc/scramble: Required to use LomkitLaravelRestApiOperationExtension for automatic API documentation.
Provides
None
Conflicts
None
Replaces
None
This package is auto-updated.
Last update: 2026-06-02 19:58:07 UTC
README
👁 Social Card of Laravel Permission
Laravel Rest Api
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, ...
Requirements
PHP 8.2+ and Laravel 11+
Documentation, Installation, and Usage Instructions
See the documentation for detailed installation and usage instructions.
What It Does
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
}
}
Roadmap
- Metrics support
- Refactor the response class
- Alias for includes