# php-laravel-admin-api

**Repository Path**: QuShui/php-laravel-admin-api

## Basic Information

- **Project Name**: php-laravel-admin-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-24
- **Last Updated**: 2025-11-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


---

## 快速开始

### 1. 克隆项目

```bash
git clone <your-repo-url>
cd <project-dir>
```

### 2. 安装依赖

```bash
composer install
```

### 3. 复制环境变量

```bash
cp .env.example .env
```

### 4. 生成应用密钥

```bash
php artisan key:generate
```

### 5. 数据库迁移与填充

```bash
php artisan migrate --seed
```

### 6. 启动开发环境（Octane + 队列）

```bash
./scripts/up-enhanced.sh
```

---

## 常用命令

- **代码格式化**：`./vendor/bin/pint`
- **单元测试**：`php artisan test`
- **队列监听**：`php artisan queue:work`
- **Octane 启动**：`php artisan octane:start`
- **生成 JWT 密钥**：`php artisan jwt:secret`

---

## 代码规范

- 严格类型声明：`declare(strict_types=1);`
- PSR-12 编码规范
- 控制器/服务/模型/DTO/Request/中间件分层
- 所有 API 响应使用统一 `Result` 格式
- 异常处理统一在 `bootstrap/app.php` 注册
- 所有模型字段批量赋值需声明 `$fillable`
- 软删除唯一索引校验需加 `whereNull('deleted_at')`
- 推荐为常用字段+`deleted_at` 建联合索引

---

## 权限与认证

- JWT 认证中间件：`auth.admin`
- 权限中间件：`permission.admin`
- 频率限制中间件：`throttle:admin`
- 内容协商中间件：`ContentNegotiation`

---

## 软删除与索引优化

- 所有重要业务表建议开启软删除
- 唯一性校验需加 `whereNull('deleted_at')`
- 推荐为常用查询字段+`deleted_at` 建联合索引

---

## 贡献与开发

- 代码提交前请运行 `./vendor/bin/pint` 格式化代码
- 单元测试覆盖率建议 > 80%
- 详细开发规范见项目内 `docs/` 或注释

---

## License

MIT

---

> 如有问题请联系项目维护者或提交 Issue。