ethercreative/yii2-app-api

Yii 2 RESTful API Template

Yii 2 API Project Template

REQUIREMENTS

The minimum requirement by this project template that your Web server supports PHP 5.4.0., _(*1)

INSTALLATION

Install from an Archive File

Extract the archive file downloaded from github.com to a directory named api that is directly under the Web root., _(*2)

Set cookie validation key in config/web.php file to some random secret string:, _(*3)

'request' => [
    // !!! insert a secret key in the following (if it is empty) - this is required by cookie validation
    'cookieValidationKey' => '<secret random string goes here>',
],

You can then access the application through the following URL:, _(*4)

http://localhost/api/web/

Install via Composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org., _(*5)

You can then install this project template using the following command:, _(*6)

php composer.phar global require "fxp/composer-asset-plugin:~1.1.1"
php composer.phar create-project --prefer-dist --stability=dev ethercreative/yii2-app-api api

Now you should be able to access the application through the following URL, assuming api is the directory directly under the Web root., _(*7)

http://localhost/api/web/

CONFIGURATION

Database

Edit the file config/db.php with real data, for example:, _(*8)

return [
    'class' => 'yii\db\Connection',
    'dsn' => 'mysql:host=localhost;dbname=yii2basic',
    'username' => 'root',
    'password' => '1234',
    'charset' => 'utf8',
];

NOTES: - Yii won't create the database for you, this has to be done manually before you can access it. - Check and edit the other files in the config/ directory to customize your application as required. - Refer to the README in the tests directory for information specific to basic application tests., _(*9)