Re-migrate code
This commit is contained in:
30
README.md
30
README.md
@@ -163,8 +163,8 @@ APP_JWT_SECRET=my-secret-key # 覆盖 jwt.secret
|
||||
**开发环境(.env)**:
|
||||
```bash
|
||||
# 使用 SQLite
|
||||
DATABASE_DRIVER=sqlite
|
||||
DATABASE_PATH=./data/dev.sqlite
|
||||
APP_DATABASE_DRIVER=sqlite
|
||||
APP_DATABASE_SQLITE_PATH=./data/dev.sqlite
|
||||
```
|
||||
|
||||
**生产环境(环境变量)**:
|
||||
@@ -194,6 +194,11 @@ curl -X POST http://localhost:3000/api/auth/login \
|
||||
-d '{"username":"admin","password":"password123"}'
|
||||
```
|
||||
|
||||
首次启动且用户表为空时,系统会自动创建默认管理员账号(请在生产环境立即修改密码):
|
||||
|
||||
- username: `admin`
|
||||
- password: `Beifan@2026`
|
||||
|
||||
## API 文档
|
||||
|
||||
项目使用 Swagger 生成交互式 API 文档。
|
||||
@@ -230,6 +235,7 @@ swag init -g main.go
|
||||
| 方法 | 路径 | 描述 | 需要认证 |
|
||||
| ---- | --------------------------- | ----------------------- | -------- |
|
||||
| POST | `/api/auth/login` | 用户登录,返回 JWT 令牌 | 否 |
|
||||
| POST | `/api/auth/logout` | 用户登出 | 是 |
|
||||
| GET | `/api/auth/profile` | 获取当前用户信息 | 是 |
|
||||
| PUT | `/api/auth/profile` | 更新用户信息 | 是 |
|
||||
| POST | `/api/auth/change-password` | 修改密码 | 是 |
|
||||
@@ -243,6 +249,7 @@ swag init -g main.go
|
||||
| POST | `/api/serials/:serialNumber/qrcode` | 生成序列号二维码 | 是 | 任何 |
|
||||
| GET | `/api/serials/:serialNumber/query` | 查询序列号信息 | 否 | 任何 |
|
||||
| GET | `/api/serials` | 获取序列号列表 | 是 | 任何 |
|
||||
| PATCH | `/api/serials/:serialNumber` | 更新序列号信息 | 是 | 管理员 |
|
||||
| PUT | `/api/serials/:serialNumber` | 更新序列号信息 | 是 | 管理员 |
|
||||
| POST | `/api/serials/:serialNumber/revoke` | 吊销序列号 | 是 | 管理员 |
|
||||
|
||||
@@ -250,9 +257,14 @@ swag init -g main.go
|
||||
|
||||
| 方法 | 路径 | 描述 | 需要认证 | 角色 |
|
||||
| ------ | ----------------------------- | ------------ | -------- | ------ |
|
||||
| GET | `/api/companies` | 获取企业列表 | 是 | 任何 |
|
||||
| GET | `/api/companies/stats/overview` | 获取企业统计概览 | 是 | 管理员 |
|
||||
| GET | `/api/companies` | 获取企业列表 | 是 | 管理员 |
|
||||
| GET | `/api/companies/:companyName` | 获取企业详情 | 是 | 管理员 |
|
||||
| POST | `/api/companies` | 创建新企业 | 是 | 管理员 |
|
||||
| PATCH | `/api/companies/:companyName` | 更新企业信息 | 是 | 管理员 |
|
||||
| PUT | `/api/companies/:companyName` | 更新企业信息 | 是 | 管理员 |
|
||||
| POST | `/api/companies/:companyName/revoke` | 吊销企业及序列号 | 是 | 管理员 |
|
||||
| DELETE | `/api/companies/:companyName/serials/:serialNumber` | 删除企业下序列号 | 是 | 管理员 |
|
||||
| DELETE | `/api/companies/:companyName` | 删除企业 | 是 | 管理员 |
|
||||
|
||||
### 员工赋码
|
||||
@@ -261,10 +273,11 @@ swag init -g main.go
|
||||
| ---- | -------------------------------------- | ------------------ | -------- | ------ |
|
||||
| POST | `/api/employee-serials/generate` | 生成员工序列号 | 是 | 管理员 |
|
||||
| GET | `/api/employee-serials` | 获取员工序列号列表 | 是 | 任何 |
|
||||
| GET | `/api/employee-serials/:serial/query` | 查询员工序列号信息 | 否 | 任何 |
|
||||
| POST | `/api/employee-serials/:serial/qrcode` | 生成员工二维码 | 是 | 任何 |
|
||||
| PUT | `/api/employee-serials/:serial` | 更新员工序列号信息 | 是 | 管理员 |
|
||||
| POST | `/api/employee-serials/:serial/revoke` | 吊销员工序列号 | 是 | 管理员 |
|
||||
| GET | `/api/employee-serials/:serialNumber/query` | 查询员工序列号信息 | 否 | 任何 |
|
||||
| POST | `/api/employee-serials/:serialNumber/qrcode` | 生成员工二维码 | 是 | 任何 |
|
||||
| PATCH | `/api/employee-serials/:serialNumber` | 更新员工序列号信息 | 是 | 管理员 |
|
||||
| PUT | `/api/employee-serials/:serialNumber` | 更新员工序列号信息 | 是 | 管理员 |
|
||||
| POST | `/api/employee-serials/:serialNumber/revoke` | 吊销员工序列号 | 是 | 管理员 |
|
||||
|
||||
**员工序列号特点**:
|
||||
- 无有效期限制(与企业赋码不同)
|
||||
@@ -296,10 +309,11 @@ go tool cover -html=coverage.out
|
||||
|
||||
### 当前测试覆盖
|
||||
|
||||
- **services/**: 包含 AuthService、SerialsService 和 EmployeeSerialsService 的完整单元测试
|
||||
- **services/**: 包含 AuthService、SerialsService、EmployeeSerialsService 和 CompaniesService 的完整单元测试
|
||||
- 用户认证测试(登录、获取用户信息、修改密码、更新资料)
|
||||
- 序列号管理测试(生成、查询、更新、吊销、分页列表)
|
||||
- 员工赋码测试(生成、查询、更新、吊销、二维码生成)
|
||||
- 企业统计测试(统计概览)
|
||||
- **tests/**: 集成测试(健康检查、登录流程)
|
||||
|
||||
## 代码检查
|
||||
|
||||
Reference in New Issue
Block a user