yiisoft/yii-base-api
Yii Framework REST API Application Base
dev-master / 3.0.x-dev
2019-12-06 16:40 UTC
Requires
- yiisoft/yii-rest: ^3.0@dev
- yiisoft/di: ^3.0@dev
- yiisoft/log: ^3.0@dev
- yiisoft/cache: ^3.0@dev
- yiisoft/active-record: ^3.0@dev
- vlucas/phpdotenv: ^2.5
- hiqdev/composer-config-plugin: ^1.0@dev
- php: ^7.4
Requires (Dev)
- phpunit/phpunit: ^8.4
README
Yii Framework REST API Application
This package is Yii Framework REST API application best for rapidly creating projects.
The template includes all commonly used configurations that would allow you to focus on adding new features to your application.
DIRECTORY STRUCTURE
bin/
config/ contains application configurations
runtime/ contains files generated during runtime
src/
controllers/ contains Api controller classes
models/ contains model classes
tests/ contains various tests for the basic application
vendor/ contains dependent 3rd-party packages
.env
.env.dist
composer.json
REQUIREMENTS
The minimum requirement by this project template that your Web server supports PHP 7.2.
INSTALLATION
If you do not have Composer, you may install it by following the instructions at getcomposer.org.
You can then install this project template using the following command:
composer create-project --prefer-dist --stability=dev yiisoft/app myapp
cd myapp
./vendor/bin/yii serve
Now you should be able to access the application via http://localhost:8080/
.
CONFIGURATION
Database
Edit the file config/db.php
with real data, for example:
return [ '__class' => \Yiisoft\Db\Connection::class, 'dsn' => 'mysql:host=localhost;dbname=yii2basic;charset=utf8', 'username' => 'root', 'password' => '1234', ];
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.
TESTING
Tests are located in tests
directory.