ดาวน์โหลด boilerplate express entity based - ดาวน์โหลดซอร์สโค้ด boilerplate express entity based

boilerplate express entity based

หมวดหมู่อื่นๆ

Security Updates

ดาวน์โหลด

Express-Lemon: หม้อต้มส่วนหลัง

คำอธิบาย

อุดมการณ์
เอนทิตีมิดเดิลแวร์
บริการ
คำสั่ง

การติดตั้ง

ความต้องการ
ขั้นตอนการติดตั้ง
เรียกใช้แพ็คเกจ

คำอธิบาย

สถาปัตยกรรม API เริ่มต้น ประกอบด้วยชุดโมดูล บริการ และการกำหนดค่าพื้นฐานและต้องมี

อุดมการณ์

ใช้ Express Middlewares เพื่อแยกฟังก์ชันการทำงานและแยกส่วนต่างๆ ตามตรรกะ เราเตอร์/ปลายทางแต่ละตัวอาจมีสายมิดเดิลแวร์เพื่อตรวจสอบข้อมูล โหลดข้อมูลจากแหล่งข้อมูล ข้อมูลแผนที่ ตรวจสอบสิทธิ์ และดำเนินการตามตรรกะทางธุรกิจหลัก

แต่ละฟังก์ชันมิดเดิลแวร์ควรมี ชื่อเดียวกัน ตลอดทั้งชุดลูกโซ่

ตัวอย่าง: หากคำขอใหม่ของกระบวนการสร้างผู้ใช้ผ่านฟังก์ชันมิดเดิลแวร์หลายฟังก์ชัน คำขอทั้งหมดควรมีชื่อเดียวกัน ( createOne(req, res, next) )

* ข้อยกเว้น: มิดเดิลแวร์ 'ตัวช่วย' ที่ไม่เกี่ยวข้อง

ตัวอย่าง:

 appRoute.get('/:userId',
  authMiddleware.isAuthenticated,
  acl.getOne,
  validator.getOne,
  loader.getOne,
  controller.getOne,
);

เอนทิตีมิดเดิลแวร์

./app/middlewares/

เชื่อมโยงรายการเพื่อทำหน้าที่เฉพาะของตนเอง

การควบคุมการเข้าถึง (accessControl)

ตรวจสอบว่าคำขอปัจจุบันอาจเข้าถึงตรรกะทางธุรกิจหรือไม่ เลเยอร์นี้อาจตรวจสอบว่าผู้ใช้ที่เข้าสู่ระบบมีสิทธิ์ดำเนินการตามคำขอนี้หรือไม่

ตัวอย่าง:

 async getOne(req, res, next) {
    if (mainAcl.isAdmin(req.user)) {
      return next();
    }

    const userIdRequested   = req.params.userId;
    const userIdCurrent     = req.user._id.toString();

    if (userIdRequested === userIdCurrent) {
      return next();
    }

    return next(new Forbidden());
},

ผู้ทำแผนที่ข้อมูล (dataMappers)

แผนที่ข้อมูลขาออก/ขาเข้าสำหรับการประมวลผลเพิ่มเติมโดยฟังก์ชันอื่น

ตัวอย่าง:

 updateOne(req, res, next) {
    delete req.body.password;
    delete req.body.confirm_password;
    return next();
},

เครื่องมือตรวจสอบข้อมูล (dataValidators)

ตรวจสอบข้อมูลขาเข้าตามกฎที่ติดตั้งไว้เพื่อป้องกันข้อมูลที่ไม่ถูกต้องจากการจัดการ

ตัวอย่าง:

 deleteOne(req, res, next) {
    req.assert('userId', 'Valid user id should be provided').notEmpty().isMongoId();
    mainValidator.handleValidationResult(mainValidator.validateErrorsSync(req), res, next);
},

ตัวโหลดเอนทิตี (entityLoaders)

โหลด/รับที่ต้องการโดยเอนทิตี/ออบเจ็กต์ตรรกะทางธุรกิจจากแหล่งข้อมูลที่มีอยู่ ระบบอาจดึงผู้ใช้หรือหน่วยงานที่เกี่ยวข้องจากฐานข้อมูลหรือประมวลผลข้อมูล

จัดเก็บและส่งเอนทิตีที่โหลดในออบเจ็กต์พิเศษภายในออบเจ็กต์ req (คำขอ) ควรใช้ บริการ Entity Loader เพื่อส่งเอนทิตีทั้งหมดและส่งผ่านภายในออบเจ็กต์คำขอ

ตัวอย่าง:

 async getOne(req, res, next) {
    try {
      const userFound = await UserService.findOne({ query: { _id: req.params.userId }, options: { lean: true } });
      if (!mainHelper.isObjectValid(userFound)) {
        throw new NotFound('user not found');
      }

      MainLoader.setEntities(req, { user: userFound });
      return next();

    } catch (err) {
      return next(err);
    }
},