damidevelopment/yii2-api

Yii 2 API Project Template

v1.0.1 2019-06-27 12:14 UTC

Requires

• php: >=5.4.0
• damidevelopment/yii2-api-utils: ^1.0
• phpmetrics/phpmetrics: ^2.4
• yii2mod/yii2-swagger: *
• yiisoft/yii2: ~2.0.14
• yiisoft/yii2-bootstrap: ~2.0.0
• yiisoft/yii2-swiftmailer: ~2.1.0

Requires (Dev)

• codeception/base: ~2.3.0
• codeception/specify: ~0.4.6
• codeception/verify: ~0.4.0
• symfony/browser-kit: >=2.7 <=4.2.4
• yiisoft/yii2-debug: ~2.1.0
• yiisoft/yii2-faker: ~2.0.0
• yiisoft/yii2-gii: ~2.1.0

BSD-3-Clause

• api
• yii2
• project template

README

REQUIREMENTS

The minimum requirement by this project template that your Web server supports PHP 7.2.0.

CREATE NEW PROJECT USING TEMPLATE

Install via Composer

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

composer create-project --prefer-dist damidev/yii2-api api

INSTALLATION

If you do not have Composer, you may install it by following the instructions at getcomposer.org.

You can then install this site using the following command:

php composer.phar install
php yii migrate

In composer.json we have postInstall script which setup permissions on files and folders. But if php script itself can't change his own files and folders, you have to change permissions yourself.

• runtime/ - folder for caching and logging
• web/assets/ - folder for caching js and css
• yii - executable for running terminal scripts (on windows machine yii.bat should be executable too, I guess)

Endpoint dev checklist

• create model
• create resource model
• create controller or/and action
• define verbs
• add AccessControl rule?
• API documentation of request (by actions annotation)
• API documentation of response (inside definitions)
• API documentation of resource (by resource's annotation)