https://github.com/taguz91/yii2-api-template

API application template using yii2 framework
https://github.com/taguz91/yii2-api-template

Last synced: about 1 month ago
JSON representation

API application template using yii2 framework

• Host: GitHub
• URL: https://github.com/taguz91/yii2-api-template
• Owner: taguz91
• License: bsd-3-clause
• Created: 2021-10-28T03:30:29.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-12-04T15:25:30.000Z (about 3 years ago)
• Last Synced: 2024-04-18T08:21:17.954Z (8 months ago)
• Language: PHP
• Size: 62.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


    

        

    

    
Yii 2 API Template

    


### Getting starter

```bash

# 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

```