API Files
Tiền tố /api/v1/files. Controller: files.controller.ts. Module: files.
Danh sách route
| Route | Auth | Mô tả |
|---|---|---|
POST /api/v1/files/upload | Đăng nhập (mọi vai trò), cần header folder_type | Tải một file lên thư mục chọn bằng header folder_type |
DELETE /api/v1/files/remove | Đăng nhập, vai trò: SUPER ADMIN | Xóa một file đã tải lên (quản trị viên) |
Upload
POST /files/upload nhận multipart/form-data với một file. Thư mục đích chọn bằng header folder_type, không phải field trong body:
folder_type | Loại file | Tối đa | Ai được phép |
|---|---|---|---|
avatar | jpg, jpeg, png, gif, webp | 5 MB | Người dùng đăng nhập |
company | jpg, jpeg, png, gif | 5 MB | Chỉ HR và SUPER ADMIN |
File CV không đi qua route này: POST /resumes/upload-cv lưu vào thư mục private và chỉ đọc được qua GET /resumes/:id/file.
Phản hồi (data) theo getFileInfo (files.service.ts):
{
"fileName": "<tên file do server đặt>",
"originalName": "logo.png",
"mimeType": "image/png",
"size": 12345,
"folderType": "company",
"url": "<đường dẫn truy cập file>"
}
Giá trị trong ví dụ là minh họa. Tên file do server đặt, không dùng tên gốc.
Xóa file
DELETE /files/remove chỉ SUPER ADMIN, nhận fileName và folderType (khớp mẫu Matches, xem DTO) và trả { "deleted": true }.
Chi tiết từng route
POST /api/v1/files/upload
Tải một file lên thư mục chọn bằng header folder_type
- Auth: Đăng nhập (mọi vai trò), cần header
folder_type - Handler:
uploadFiletrong files.controller.ts - Mã thành công: 201,
message= "Upload single file"
Upload: nhận file qua multipart/form-data (@UploadedFile).
Phản hồi theo Swagger
| Mã | Mô tả |
|---|---|
| 201 | File uploaded successfully. |
DELETE /api/v1/files/remove
Xóa một file đã tải lên (quản trị viên)
- Auth: Đăng nhập, vai trò: SUPER ADMIN
- Handler:
deleteFiletrong files.controller.ts - Mã thành công: 200,
message= "Delete file"
Body: DeleteFileDto (delete-file.dto.ts)
| Field | Kiểu | Bắt buộc | Validation | Ví dụ |
|---|---|---|---|---|
fileName | string | Có | IsNotEmpty, IsString, Matches | 'logo-1704067200000.png' |
folderType | string | Có | IsNotEmpty, IsString, Matches | 'company' |
Phản hồi theo Swagger
| Mã | Mô tả |
|---|---|
| 200 | File deleted successfully. |