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

API Skills

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

catalog và popular công khai để giao diện hiển thị danh mục và gợi ý. Các route còn lại chỉ cho SUPER ADMIN.

Danh sách route​

RouteAuthMô tả
GET /api/v1/skills/catalogCông khaiDanh mục kỹ năng đang hoạt động (công khai), có thể tìm theo search
GET /api/v1/skills/popularCông khaiKỹ năng được yêu cầu nhiều nhất (công khai)
POST /api/v1/skillsĐăng nhập, vai trò: SUPER ADMINTạo kỹ năng trong danh mục (quản trị viên)
GET /api/v1/skillsĐăng nhập, vai trò: SUPER ADMINLiệt kê kỹ năng có phân trang (quản trị viên)
GET /api/v1/skills/:idĐăng nhập, vai trò: SUPER ADMINXem một kỹ năng (quản trị viên)
PATCH /api/v1/skills/:idĐăng nhập, vai trò: SUPER ADMINCập nhật kỹ năng (quản trị viên)
DELETE /api/v1/skills/bulkĐăng nhập, vai trò: SUPER ADMINXóa mềm nhiều kỹ năng (quản trị viên)
DELETE /api/v1/skills/:idĐăng nhập, vai trò: SUPER ADMINXóa mềm một kỹ năng (quản trị viên)

Quy tắc​

  • label và slug không được trùng (kiểm tra ở ứng dụng, không có unique index).
  • slug sinh tự động từ label.
  • aliases tối đa 30 phần tử, mỗi phần tử tối đa 100 ký tự; alias trùng label bị bỏ.
  • GET /skills (quản trị) dùng api-query-params không có allowlist trường lọc, xem api-overview.
  • catalog và popular được cache trong bộ nhớ tiến trình (data-flow).

Chi tiết từng route​

GET /api/v1/skills/catalog​

Danh mục kỹ năng đang hoạt động (công khai), có thể tìm theo search

  • Auth: Công khai
  • Handler: getCatalog trong skills.controller.ts
  • Mã thành công: 200, message = "Get active skills catalog"

Query

TênBắt buộcMô tảVí dụ
searchKhông'node'
limitKhông100

GET /api/v1/skills/popular​

Kỹ năng được yêu cầu nhiều nhất (công khai)

  • Auth: Công khai
  • Handler: getPopular trong skills.controller.ts
  • Mã thành công: 200, message = "Get popular skills"

Query

TênBắt buộcMô tảVí dụ
limitKhông20

POST /api/v1/skills​

Tạo kỹ năng trong danh mục (quản trị viên)

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: create trong skills.controller.ts
  • Mã thành công: 201, message = "Skill created successfully"

Body: CreateSkillDto (create-skill.dto.ts)

FieldKiểuBắt buộcValidationVí dụ
labelstringCóIsNotEmpty, IsString, MaxLength(100)'Node.js'
aliasesstring[]KhôngIsArray, ArrayMaxSize(30), IsString, MaxLength(100)['node', 'nodejs', 'node js']
categorystringKhôngIsString, MaxLength(100)'Backend'
descriptionstringKhôngIsString, MaxLength(500)'JavaScript runtime commonly used for backend development'
isActivebooleanCóIsNotEmpty, IsBooleantrue

GET /api/v1/skills​

Liệt kê kỹ năng có phân trang (quản trị viên)

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: findAll trong skills.controller.ts
  • Mã thành công: 200, message = "Skills have been retrieved successfully"

Query

TênBắt buộcMô tảVí dụ
pageKhông
limitKhông
(toàn bộ query string)—Đọc bằng api-query-params: hỗ trợ lọc và sắp xếp (xem api-overview)

GET /api/v1/skills/:id​

Xem một kỹ năng (quản trị viên)

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: findOne trong skills.controller.ts
  • Mã thành công: 200, message = "Skill has been retrieved successfully"

Path params

TênKiểuMô tả
idstring

PATCH /api/v1/skills/:id​

Cập nhật kỹ năng (quản trị viên)

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: update trong skills.controller.ts
  • Mã thành công: 200, message = "Skill updated successfully"

Path params

TênKiểuMô tả
idstring

Body: UpdateSkillDto (update-skill.dto.ts)

Kế thừa PartialType(CreateSkillDto).

DTO không khai báo field riêng.

DELETE /api/v1/skills/bulk​

Xóa mềm nhiều kỹ năng (quản trị viên)

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: bulkRemove trong skills.controller.ts
  • Mã thành công: 200, message = "Bulk delete skills"

Body: BulkDeleteDto (bulk-delete.dto.ts)

FieldKiểuBắt buộcValidationVí dụ
idsstring[]CóIsArray, ArrayMinSize(1), ArrayMaxSize(100), IsMongoId['507f1f77bcf86cd799439011', '507f1f77bcf86cd799439012']

DELETE /api/v1/skills/:id​

Xóa mềm một kỹ năng (quản trị viên)

  • Auth: Đăng nhập, vai trò: SUPER ADMIN
  • Handler: remove trong skills.controller.ts
  • Mã thành công: 200, message = "Skill deleted successfully"

Path params

TênKiểuMô tả
idstring