taguz91/yii2-api-template

Yii 2 API Project Template

1.0.0 2021-11-03 23:46 UTC

Requires

• php: >=7.4.0
• light/yii2-swagger: ^3.0
• yiisoft/yii2: ~2.0.14
• yiisoft/yii2-bootstrap4: ~2.0.0
• yiisoft/yii2-swiftmailer: ~2.0.0 || ~2.1.0

Requires (Dev)

• codeception/codeception: ^4.0
• codeception/module-asserts: ^1.0
• codeception/module-filesystem: ^1.0
• codeception/module-yii2: ^1.0
• codeception/verify: ~0.5.0 || ~1.1.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.2.0

BSD-3-Clause

• framework
• rest
• api
• yii2
• project template

README

Yii 2 API Template

Getting starter

# Init the application dev or prod
$ php yii init
# Generate tables in sqlite 
$ php run migrate
# Run the application
$ php yii serve --docroot="api/web/"

DIRECTORY STRUCTURE

api
    assets/              contains application assets such as JavaScript and CSS
    config/              contains api configurations
    controllers/         contains Web controller classes
    models/              contains api-specific model classes
        definitions/     contains all swagger scheme definitions
    runtime/             contains files generated during runtime
    tests/               contains tests for api application
    views/               contains view files for the Web application
    web/                 contains the entry script and Web resources
    widgets/             contains api widgets
common
    config/              contains shared configurations
    mail/                contains view files for e-mails
    models/              contains model classes used in api
    tests/               contains tests for common classes    
    swagger/             contains swagger custom proccesors
console
    config/              contains console configurations
    controllers/         contains console controllers (commands)
    migrations/          contains database migrations
    models/              contains console-specific model classes
    runtime/             contains files generated during runtime
vendor/                  contains dependent 3rd-party packages
environments/            contains environment-based overrides