تنزيل boilerplate express entity based - تنزيل كود المصدر boilerplate express entity based

boilerplate express entity based

فئات أخرى

Security Updates

تنزيل

Express-Lemon: لوحة مرجعية خلفية

وصف

الأيديولوجيا
الكيانات الوسيطة
خدمات
الأوامر

تثبيت

متطلبات
خطوات التثبيت
تشغيل الحزمة

وصف

بنية واجهة برمجة التطبيقات الأولية. يحتوي على مجموعة أساسية ويجب توفرها من الوحدات والخدمات والتكوينات.

الأيديولوجيا

استخدم 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());
},

مخططو البيانات (مخططو البيانات)

يقوم بتعيين البيانات الصادرة/الواردة لمزيد من المعالجة بواسطة وظيفة أخرى.

مثال:

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

مدققو البيانات (مدققو البيانات)

التحقق من صحة البيانات الواردة وفقًا للقواعد المثبتة لمنع معالجة البيانات غير الصالحة.

مثال:

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

لوادر الكيان (entityLoaders)

عمليات التحميل/الحصول المطلوبة من قبل كيانات/كائنات منطق الأعمال من مصادر البيانات المتاحة. قد يقوم النظام باسترداد المستخدمين أو الكيانات ذات الصلة من قاعدة بيانات أو معالجة البيانات.

يقوم بتخزين وتمرير الكيانات المحملة في كائن خاص داخل كائن req (الطلب). يجب استخدام خدمة محمل الكيان لإدخال كافة الكيانات وتمريرها داخل كائن الطلب.

مثال:

 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);
    }
},