Skip to content
Add links to Laravel API resources
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
config wip Sep 20, 2019
docs Fix incorrect create issue link in docs Oct 11, 2019
src Add support for query strings Oct 16, 2019
tests Add support for query strings Oct 16, 2019
.editorconfig wip Apr 12, 2019
.gitattributes wip Apr 12, 2019
.gitignore Ignore .phpunit.result.cache Sep 17, 2019
.scrutinizer.yml wip Apr 12, 2019
.styleci.yml wip Apr 12, 2019
.travis.yml Update Oct 16, 2019 wip Apr 12, 2019 wip Apr 12, 2019 Fix `an` -> `a` typo in README Oct 14, 2019
composer.json Update dependencies Oct 4, 2019
phpunit.xml.dist wip Apr 12, 2019

Add links to Laravel API resources

Latest Version on Packagist Build Status Quality Score StyleCI Total Downloads

Let's say you have a UsersController with index, show, create, edit, store, update and delete methods and an UserResource. Wouldn't it be nice if you had the URL's to these methods immediately in your UserResource without having to construct them from scratch?

This package will add these links to your resource based upon a controller or actions you define. Let's look at an example of a resource.

class UserResource extends JsonResource
    use Spatie\ResourceLinks\HasLinks;
    use Spatie\ResourceLinks\HasMeta;

    public function toArray($request): array
        return [
            'id' => $this->id,
            'name' => $this->name,
            'links' => $this->links(UsersController::class),

    public static function meta()
        return [
            'links' => self::collectionLinks(UsersController::class),

Now when creating a UserResource collection, you will have all the links from the UserController available:

         "name": "Ruben Van Assche",
         "links": {
            "show": "",
            "edit": "",
            "update": "",
            "delete": ""
   "meta": {
      "links": {
         "index": "",
         "create": "",
         "store":  ""

Why include links in your resources?

Let's say you're building a single-page application or an application built with Inertia, then you have a PHP application running at the backend and a Javascript application at the front. These applications communicate with each other via an api but what if the frontend wants to route a user to another page?

Since routes are defined in the backend, the frontend has no idea where it has to route the user to. We could just write the url's in the javascript code but what if a route is changed? So why not pass these routes from the backend to the frontend? You could just manually write down all these routes, or let this package do that job for you.

Setting up resource links

We have a dedicated docs site for this package.


composer test


Please see CHANGELOG for more information on what has changed recently.


Please see CONTRIBUTING for details.


If you discover any security related issues, please email instead of using the issue tracker.


You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

We publish all received postcards on our company website.


Support us

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.


The MIT License (MIT). Please see License File for more information.

You can’t perform that action at this time.