boilerplate express entity based

Express-Lemon: Pelat Boiler Ujung Belakang

1. Keterangan

• Ideologi
• Entitas Middleware
• Layanan
• Perintah

2. Instalasi

• Persyaratan
• Langkah-Langkah Instalasi
• Menjalankan paket

Keterangan

Arsitektur API Awal. Berisi kumpulan modul, layanan, dan konfigurasi dasar dan wajib dimiliki.

Ideologi

Gunakan Express Middlewares untuk membagi fungsionalitas dan memisahkan bagian-bagian secara logis. Setiap router/titik akhir mungkin memiliki rantai middleware untuk memvalidasi data, memuat data dari sumber data, memetakan data, memeriksa izin, dan menjalankan logika bisnis utama.

Setiap fungsi Middleware harus memiliki nama yang sama di seluruh rangkaian rantai.

Contoh: Jika permintaan baru proses pembuatan pengguna melewati beberapa fungsi middleware, semuanya harus memiliki nama yang sama ( createOne(req, res, next) )

* Pengecualian: middleware 'pembantu' yang tidak terkait

Contoh:

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

Entitas Middleware

./app/middlewares/

Item berantai untuk menjalankan fungsi spesifiknya sendiri.

Kontrol Akses (accessControl)

Memeriksa apakah permintaan saat ini dapat mencapai logika bisnis. Lapisan ini dapat memeriksa apakah pengguna yang masuk memiliki izin untuk melakukan permintaan ini.

Contoh:

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

Pemeta Data (pemeta data)

Memetakan data Keluar/Masuk untuk diproses lebih lanjut dengan fungsi lain.

Contoh:

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

Validator Data (Validator data)

Memvalidasi data yang masuk sesuai aturan yang dipasang untuk mencegah penanganan data yang tidak valid.

Contoh:

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

Pemuat Entitas (entityLoader)

Memuat/Diperlukan oleh entitas/objek logika bisnis dari sumber data yang tersedia. Sistem dapat mengambil pengguna atau entitas terkait dari database atau memproses data.

Menyimpan dan meneruskan entitas yang dimuat dalam objek khusus di dalam objek req (permintaan). Layanan Entity Loader harus digunakan untuk mengirim semua entitas dan meneruskan objek permintaan.

Contoh:

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

Layanan

./app/services/

Layanan menjalankan fungsionalitas fokus tunggal yang akan dipanggil di dalam aplikasi untuk menangani logika bisnis.

• Layanan Otentikasi (aliran token akses/penyegaran)
• Layanan Kripto
• Layanan Basis Data
• Layanan Email
• Layanan Pemuat Entitas
• Layanan Log
• Layanan Respon
• Layanan Pengguna

Perintah

./commands

• Skrip pembuatan Pengguna Admin

Instalasi

Persyaratan

simpul

Kunjungi https://nodejs.org untuk detail instalasi.

npm

Node Package Manager, harus dibundel dengan node.js.

MongoDB

Instal MongoDB https://docs.mongodb.com/manual/installation/

Langkah-Langkah Instalasi

Kloning paketnya

1. Buat folder dengan nama yang dipilih
2. Jalankan $ git clone <package url> .

menginstal dependensi

1. Buka folder root paket
2. Jalankan $ npm install

Pengaturan Aplikasi

1. Buat file config/env/env.local dan salin data dari config/env/env.local_example
2. Perbarui pengaturan sesuai dengan kebutuhan dan spesifikasi lingkungan Anda

Pengaturan Lingkungan Uji

1. Buat file config/env/.env.test dan salin data dari config/env/.env.test_example
2. Perbarui pengaturan sesuai dengan kebutuhan dan spesifikasi lingkungan Anda

Menjalankan paket

$ npm run start:[environment]

Contoh: $ npm run start:local