使用说明

架构流程

请求(Request) -> 路由(Router) -> 控制器(Controller) -> 业务模块(Module) -> 返回结果及数据(HTTP/Response,业务相关) Restful

业务模块 Module

命令

创建完整api接口。包含CURD方法

php artisan make:api ModuleName ActionName -F

* ActionName中建议包含ModuleName

创建单个api接口

php artisan make:api ModuleName ActionName

更新模块

在手动新创建一些文件后，需要更新模块关联时 php artisan api:generate ModuleName

数据迁移规范

• 所有数据库结构操作(建表,修改表等)，都使用数据迁移管理
• 未上线之前，尽量减少迁移文件。但要保证迁移文件正确再提交
• 上线后，必须使用新的迁移文件做数据库结构的调整

默认数据填充

php artisan db:seed
php artisan db:seed --class=Xxx

列表通用筛选

query参数说明

参数：query=field:operator:value;field2:operator:value

• query：url参数
• field、field2：要筛选的字段
• operator：操作符。默认为等号“=”
• value： 查询的值

例：query=category_id:1;status:in:1,2;content:like:%使用%

查询 category_id=1 且 status in (1,2) 且 content like '%使用%'

规范

URL

• 所有字母使用小写
• Query变量名称多个单词使用下划线连接
• Resource单词使用名词、单数形式 例：https://domain.com/user/{user}?per_page=10

CLASS类

• 使用名词
• 第一个字母大写+驼峰命名
• ClassName + Action|Repository|Resource

普通变量

• 驼峰命名

编码

Repository

with中的 Criteria 使用

    $repository->withWhenLoad([
        'tags' => function ($builder) use ($repository) {
            (new StatusCriteria(request()))->apply($builder, $repository, 'pest_tag.status');
        },
    ]);

常见问题

问：seed不存在

答：更新composer缓存

composer dump-autoload

问：命令行出现乱码

答：设置php.ini文件

input_encoding = UTF-8
output_encoding = UTF-8