oteixido/yii2-rest-backend

Components to use a REST backend in Yii2 applications

0.1 2018-03-31 20:14 UTC

Requires

• ext-curl: *
• yiisoft/yii2: *

Requires (Dev)

• codeception/codeception: ~2.4

GPL-3.0

• Oriol Teixidó

• extension
• yii2

README

REST backend for Yii2 applications.

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require oteixido/yii2-rest-backend "*"

or add

"oteixido/yii2-rest-backend": "*"

to the require section of your composer.json file.

Configuration

To use this extension, simply add the following code in your application configuration:

return [
    //....
    'components' => [
        'httpClient' => [
            'class' => '\oteixido\rest\http\HttpClient',
            'baseUrl' => 'https://localhost.localdomain/api/v1',
            'username' => 'username',    // Default no username
            'password' => 'password',    // Default no password
            'timeout' => 5,              // Default 10 seconds
            'sslVerify' => false,        // Default true
        ],
    ],
];

Testing

Create docker image yii2-rest-backend for testing environment.

$ docker build . --tag yii2-rest-backend
$ docker run -it --rm -v "$PWD":/app -w /app yii2-rest-backend composer install

Execute tests.

$ docker run -it --rm -v "$PWD":/app -w /app yii2-rest-backend ./vendor/bin/codecept run --coverage

License

GNU General Public License v3.0