Skip to content

Tham chiếu dữ liệu backend ​

Frontend không có database và không định nghĩa schema lưu trữ. Trang này chỉ ra mỗi model ở frontend tương ứng với collection nào ở backend, và dẫn tới tài liệu database của backend. Dành cho người cần biết một field được lưu ở đâu hoặc có quan hệ với dữ liệu nào.

Vì sao schema chỉ nằm ở backend ​

Backend dùng NestJS với Mongoose trên MongoDB, và là nơi quyết định field nào được lưu, index nào có và quan hệ giữa các collection. Nếu frontend cũng mô tả database thì sẽ có hai bản dần lệch nhau. Vì vậy ở frontend chỉ có hợp đồng dữ liệu: type TypeScript, schema Zod và trạng thái giao diện.

WARNING

Các link sang backend dùng nhánh main của repo it-job-portal-be. Tài liệu database của backend nằm trong nhánh chưa được merge vào main tại thời điểm viết, nên các link này chỉ chạy sau khi nhánh đó được merge.

Bảng đối chiếu ​

Dữ liệuNơi định nghĩa ở frontendCollection ở backend
Người dùng, tài khoảnIUser, IAccount trong src/shared/types/backend.d.ts; schema Zod ở src/features/user/schemas/user.schema.ts và src/features/auth/schemas/auth.schema.tsusers
Tin tuyển dụng nội bộIJob trong backend.d.ts; schema Zod ở src/features/job/schemas/job.schema.tsjobs
Kết quả tìm kiếm hợp nhất, tin bên ngoàiJobSearchItem, ExternalJobDetail ở src/features/job/schemas/job-search.schema.tsexternal-jobs và jobs
Hồ sơ ứng tuyểnIResume trong backend.d.ts; schema Zod ở src/features/resume/schemas/resume.schema.tsresumes
Hồ sơ CVsrc/features/cv-builder/schemas/cv-profile.schema.ts, src/shared/types/cv.d.tscv-profiles
Tin nhắn chatsrc/shared/types/chat.d.tschat-messages
Công tyICompany trong backend.d.ts; schema Zod ở src/features/company/schemas/company.schema.tscompanies
Thông báosrc/features/notification/schemas/notification.schema.tsnotifications
Đăng ký nhận việcISubscribers trong backend.d.ts; schema Zod ở src/features/subscriber/schemas/subscriber.schema.tssubscribers
Kỹ năngsrc/features/skill/schemas/skill.schema.tsskills

Trang models/* mô tả từng model ở phía frontend; chỉ một phần model có trang riêng, các trang còn lại được viết theo từng đợt.

Cách đọc một model ​

Khi cần biết một field, đọc theo thứ tự:

  1. Trang models/* của frontend: field nào frontend dùng và ý nghĩa nghiệp vụ.
  2. Tài liệu collection của backend: field đó lưu thế nào, có index hay ràng buộc gì.
  3. Mã nguồn backend, khi hai nơi trên khác nhau. Code đúng hơn tài liệu.

NOTE

Một model có thể có nhiều định nghĩa ở frontend: interface trong backend.d.ts, schema Zod trong features/*/schemas/ và type riêng cho form. Chúng không tự đồng bộ. Mỗi trang model sẽ ghi type nào là chính và chỉ ra chỗ chúng khác nhau.

Quan hệ giữa các collection ​

Sơ đồ quan hệ, chỉ mục và ràng buộc nằm ở backend:

Tài liệu này không mô tả lại các nội dung đó.

Source code liên quan ​

Đọc tiếp: Tổng quan API và dữ liệu, Quy ước API, Bối cảnh hệ thống.

Tài liệu kỹ thuật xây dựng theo chuẩn Documentation as Code