guancheng/msgpack

The lumen api response wrapper for rybakit/msgpack.

0.2 2017-06-02 02:18 UTC

Requires

• php: >=5.5.9
• illuminate/http: ~5.3
• illuminate/support: ~5.3
• rybakit/msgpack: ^0.2.2
• symfony/http-kernel: ~2.7|~3.0

Requires (Dev)

• illuminate/routing: ~5.3
• mockery/mockery: ~0.9
• phpunit/phpunit: ~4.0
• vlucas/phpdotenv: ~2.0

MIT

• Peter Lai

• api
• msgpack
• lumen

README

The lumen api response wrapper for rybakit/msgpack.

Install

composer require guancheng/msgpack

or

clone / download this repo

Usage

Response

use Illuminate\Routing\Controller;
use LGC\Msgpack\MsgpackResponse;

class TestController extends Controller
{
    public function test()
    {
        return new MsgpackResponse([
            'success' => true
        ]);
    }
}

If you want to return Arrayable object, just do it!

use Illuminate\Support\Collection;
use Illuminate\Routing\Controller;
use LGC\Msgpack\MsgpackResponse;

class TestController extends Controller
{
    public function test()
    {
        return new MsgpackResponse([
            'success' => true,
            'data' => new Collection([
            	'hello' => 'lumtify'
            ])
        ]);
    }
}

When use arrayable types you have to notice: due to we don't remember pack data type, so the getData() always return array

Test

use LGC\Msgpack\MsgpackConcern;

class TestApiTest extends PHPUnit_Framework_TestCase
{
    use MsgpackConcern;

    public function testShouldSeeMsgpack()
    {
    	$this->shouldSeeMsgpack();
    }
}

Development

clone the repo

composer install

Roadmap

Make other laravel data type transformer.

Licence

MIT

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!