xk-docs/docs/projects/xk-api/overview.md

xk-api 概览

xk-api 是 XK 系统的核心 API 服务，基于 Laravel 12 构建，承载所有业务逻辑。

基本信息

项	值
框架	Laravel 12.x
PHP 版本	>= 8.4
包管理	Composer
认证	Laravel Sanctum + 自定义 JWT
队列	RabbitMQ (vladimir-yuldashev/laravel-queue-rabbitmq)
性能	LaravelS (hhxsv5/laravel-s)
文件存储	阿里云 OSS
支付	微信支付 + 易票联 (EPL)
短信	EasySms (阿里云短信)
Excel	Maatwebsite/Excel + PHPSpreadsheet

目录结构

xk-api/
├── app/
│   ├── BaseApp/          # 基础应用类
│   ├── Console/Commands/ # Artisan 命令 (10个)
│   ├── Constants/        # 常量定义
│   ├── Core/             # 核心逻辑
│   ├── Enum/             # 枚举类 (30+)
│   ├── Excel/            # Excel 导出
│   ├── Http/
│   │   ├── Controllers/  # 控制器 (116个)
│   │   └── Middleware/    # 中间件
│   ├── Jobs/             # 队列任务 (24个)
│   ├── Mail/             # 邮件
│   ├── Models/
│   │   ├── old/          # 旧模型 (Yii表, ~130个)
│   │   └── new/          # 新模型 (xk表, ~100个)
│   ├── Providers/        # 服务提供者
│   ├── Service/          # 业务服务 (~160个)
│   └── Support/          # 支撑类
├── config/               # 配置文件 (17个)
├── database/             # 迁移、种子
├── docs/                 # 项目文档
├── routes/               # 路由定义 (9个文件)
├── scripts/              # 脚本工具
└── tests/                # 测试

路由入口

路由文件	前缀	端	说明
admin.php	/api/admin	管理后台	50+ 路由组，覆盖系统管理、业务、财务
mobile.php	/api/mobile	患者小程序	问诊、购药、挂号、处方、转诊
doctor.php	/api/doctor	医生端小程序	8 种角色独立路由组
hy.php	/api/hy	监管中转	批次管理、数据拉取、回调
callback.php	/api/callback	支付回调	易票联、微信支付
open-api.php	/api/open	开放 API	上传、同步、数据大屏

关键配置文件

文件	说明
config/xk.php	XK 项目专属配置
config/ase.php	加密配置
config/laravels.php	LaravelS 性能优化配置
config/queue.php	队列配置 (RabbitMQ)
config/filesystems.php	文件系统 (OSS)

现有文档

文档	说明
docs/hy-transit-api.md	互联网医院监管中转 API 接口文档
定时任务命令表.md	定时任务命令索引
新互联网医院监管平台文档.md	浙江省互联网医院监管平台接口规范 v2.0
转接方分账和处方来源修改_影响分析.md	转诊分账逻辑影响分析
《和利康源中药智能制造 MES 系统接口说明 V1.2》.md	MES 系统接口规范