fbacks/yii2-api-template

Yii 2 REST API 模板

v0.1 2019-09-11 19:30 UTC

README

这是一个使用 Yii2 构建的 REST API 模板。这个模板采用 Yii2-Micro 方法,因此它将轻量级且易于部署。

Packagist Version Packagist Downloads

详细文档可以在以下位置找到:docs/README.md

需求

本项目模板的最小要求是您的 Web 服务器支持 PHP 5.4.0。此外,建议您的 PHP 安装已启用以下模块

  • intl:用于在 Yii::t() 中使用高级参数格式化

要检查完整要求,请将项目根目录中的 requirements.php 复制到 api/web 文件夹,然后通过您的网页浏览器导航到该文件。

安装

安装此模板的首选方式是通过 composer 使用以下命令

composer create-project --prefer-dist fbacks/yii2-api-template [app_name]

目录结构

common
    config/              contains shared configurations
    mail/                contains view files for e-mails
    models/              contains model classes used in both backend and frontend
    tests/               contains tests for common classes    
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
api
    config/              contains api configurations
    modules/             contains Web controller classes
    runtime/             contains files generated during runtime
    tests/               contains tests for api application    
    web/                 contains the entry script and Web resources
vendor/                  contains dependent 3rd-party packages
environments/            contains environment-based overrides