stephenlake/laravel-shovel

A minimal package for shovelling data from an API to clients, for Laravel.

Maintainers

Details

github.com/cloudcake/laravel-shovel

Source

Issues

Installs: 3 290

Dependents: 0

Suggesters: 0

Security: 0

Stars: 96

Watchers: 5

Forks: 4

Open Issues: 0

pkg:composer/stephenlake/laravel-shovel

v2.1.6 2019-11-19 21:03 UTC

Requires (Dev)

MIT 39194047af42f1cd57a65a3fc77bbf3e03586412

  • Stephen Lake <stephen.woop@closurecode.com>

This package is auto-updated.

Last update: 2025-10-29 02:09:30 UTC

README

downloads license

Laravel Shovel is a minimalist package providing Laravel response macros to assist in rapid API development by transforming models, resources, collections, paginated objects and errors into a concise API response format. DRY.

Getting Started

Install the package via composer.

composer require cloudcake/laravel-shovel

Transform Post::paginate(); into

{
  "meta": {
    "status": "success",
    "message": "OK",
    "code": 200,
    "pagination": {
      "records": 42312,
      "page": 1,
      "pages": 2821,
      "limit": 15
    }
  },
  "data": [{...},{...},{...}]
}

Using regular methods, response(Post::paginate()); or response(Resource::collection(Post::paginate()).

See documentation for more information.

License

This library is licensed under the MIT License - see the LICENSE.md file for details.