Chuyển tới nội dung chính

API Files

Tiền tố /api/v1/files. Controller: files.controller.ts. Module: files.

Danh sách route​

RouteAuthMô tả
POST /api/v1/files/uploadĐăng nhập (mọi vai trò), cần header folder_typeTả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 ADMINXó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_typeLoại fileTối đaAi được phép
avatarjpg, jpeg, png, gif, webp5 MBNgười dùng đăng nhập
companyjpg, jpeg, png, gif5 MBChỉ 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: uploadFile trong 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ả
201File 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: deleteFile trong files.controller.ts
  • Mã thành công: 200, message = "Delete file"

Body: DeleteFileDto (delete-file.dto.ts)

FieldKiểuBắt buộcValidationVí dụ
fileNamestringCóIsNotEmpty, IsString, Matches'logo-1704067200000.png'
folderTypestringCóIsNotEmpty, IsString, Matches'company'

Phản hồi theo Swagger

MãMô tả
200File deleted successfully.