christopherarter/laravel-resourceable

A handy method for accessing a model's value as an API resource

dev-master 2020-03-11 22:15 UTC

Requires

• php: ^7.1.3
• illuminate/config: 5.8.15|^6.0|^7.0
• illuminate/support: 5.8.15|^6.0|^7.0

Requires (Dev)

• phpunit/phpunit: ^7.5

MIT

• Chris Arter

• php
• laravel
• api resources

README

Laravel Resourceable

Laravel Resourceable is a package allowing you to quickly access a model's array value from an Api Resource class.

Installation

composer require christopherarter/laravel-resourceable

Examples

$user = new User([...]);

return $user->toResourceArray();

This package will automatically look for the resource class defined in the App\Http\Resources namespace with your ClassName + Resource appended. So for our user example, it would resolve to App\Http\Resources\UserResource.

You may also use a custom API Resource class from any namespace as a parameter:

return $user->toResourceArray(AlternateResource::class);

Why?

This allows for very accurate API HTTP testing of an endpoint, for example:

// UserTest.php

$user = factory(\App\User::class)->create();

  

$this->get(route('users.show'))

->assertJson($user->toResourceArray());

Credit

This package was written by Chris Arter with valuable contributions by Dan Alverez