项目目录文档
1. 根目录结构
ecshopx-api/
├── app/ # Lumen 应用壳
├── bootstrap/ # 框架启动引导
├── config/ # 全局配置
├── database/ # 数据库迁移、种子与工厂
├── docs/ # 项目文档
├── public/ # Web 入口
├── resources/ # 语言包、邮件/通知视图模板
├── routes/ # 按端划分的路由定义
├── src/ # 业务 Bundle 源码
├── storage/ # 运行时存储
├── tests/ # PHPUnit 自动化测试
├── vendor/ # Composer 依赖
├── artisan # 控制台命令入口
├── composer.json # PHP 依赖与 PSR-4 自动加载
├── readme_cn.md # 中文项目说明
└── CHANGELOG.md # 版本变更记录业务实现在 src/*Bundle(按域划分 Bundle,Bundle 内 Action → Service → Repository → Entity)。
2. app/ 与 bootstrap/ — Lumen 启动壳
本仓库为纯 API 服务,app/ 与 bootstrap/ 构成 Lumen 启动壳,不包含主要业务逻辑。
2.1 app/
| 路径 | 说明 |
|---|---|
AppKernel.php | 继承 Laravel\Lumen\Application,路由按需加载、Dingo 中间件调度 |
Console/ | 全局控制台命令 |
Events/、Listeners/、Jobs/ | 应用级事件、监听器与队列任务 |
Exceptions/ | 全局异常处理 |
Http/ | 应用级 HTTP 中间件 |
Providers/ | 应用级 Service Provider 注册 |
helpers.php | 全局辅助函数 |
2.2 bootstrap/
| 文件 | 说明 |
|---|---|
app.php | 创建 AppKernel、加载 .env、注册 Provider、绑定中间件别名 |
route.php | 按 https://{host}/api/... URL 路径 聚合加载 routes/ 下各端路由 |
HTTP 请求:public/index.php → bootstrap/app.php → bootstrap/route.php → Dingo 路由 → Bundle Action。
3. config/ — 全局配置
Lumen 与各 Bundle 共享的配置项,例如:
| 类别 | 示例文件 |
|---|---|
| 应用 / API | app.php、api.php、auth.php、jwt.php |
| 数据存储 | database.php、doctrine.php、cache.php、filesystems.php |
| 支付 / 第三方 | adapay.php、bspay.php、alipay.php 等 |
环境差异通过 .env 驱动;未列出的项见 config/ 目录内各文件。
4. routes/ — 按端划分的路由
由 bootstrap/route.php 按 URL 前缀加载:
| 目录 | 文件数 | 说明 |
|---|---|---|
api/ | 46 | 商户/店铺端(默认落点) |
frontapi/ | 32 | C 端 / H5 / 小程序(前缀 h5app) |
admin/ | 11 | 管理后台小程序 |
super/ | 9 | 超级管理员 |
thirdparty/ | 9 | 第三方 webhook / OpenAPI 网关 |
systemlink/ | 4 | ERP / 系统链路 |
openapi/ | 1 | 历史路由目录;现行入口见 routes/thirdparty/openapi.php |
web.php | 1 | 微信授权回调等非 Dingo 路径 |
各端 middleware、Controller 绑定定义在对应路由文件中。
5. public/ 与运行时目录
5.1 public/
index.php— HTTP 入口,加载bootstrap/app.php并派发请求。
本仓库无前端页面构建产物。
5.2 其他目录
| 目录 | 用途 |
|---|---|
database/migrations | 数据库结构迁移(Doctrine Migrations) |
database/seeders、database/seeds | 测试/初始化数据 |
database/factories | 模型工厂 |
resources/lang | 多语言文案 |
resources/views | 邮件、通知等服务端模板 |
storage/logs | 应用日志 |
storage/framework | 框架缓存、会话 |
storage/static、storage/csv | 业务导出、静态缓存 |
tests/ | PHPUnit 测试用例 |
