Home
AyaPingPing is the basename of my starter pack framework for building REST API applications. The goal is to create a simple, clean, and maintainable application environment that also has advantages in performance and security. The first AyaPingPing was made only for building REST API in NodeJS. It was around 2018/2019, when NodeJS became the only one programming language I worked with. But now, I learn and work with some new programming languages. So, I also implement AyaPingPing in other programming languages.
And this is the implementation of AyaPingPing in NodeJS. The name become AyaPingPing JS, or called ayapingping-js.
English documentation would be available soon.
Kenapa versi 3?
ayapingping-js v3 adalah versi pertama yang saya rilis untuk umum. AyaPingPing pada awalnya saya buat untuk memenuhi kebutuhan development di tempat kerja. Mulai dari v0.1 hingga terakhir v2.1 dengan serangkaian optimasi yang terus dilakukan untuk menangani kelemahan-kelematan pada versi sebelumnya. Hingga v2.1, AyaPingPing masih bersifat private.
AyaPingPing bisa terus berkembang adalah karena kontribusi dari rekan-rekan developer di kantor. Mereka mendukung saya, memberikan kritik dan masukan, serta melaporkan issue, bahkan rela mengembangkan sistem baru di dalam AyaPingPing—yang semuanya itu bertujuan membantu agar framework ini menjadi lebih baik.
Kontribusi developer lain sangatlah penting. Oleh karena itu, saya akhirnya memutuskan merilis AyaPingPing untuk umum. Dengan harapan, AyaPingPing dapat digunakan untuk membantu pekerjaan rekan-rekan developer lain di luar sana. Saya juga berharap mendapatkan feedback, sehingga kita bisa berkontribusi bersama untuk membuat framework ini menjadi lebih baik lagi kedepannya.
ayapingping-js v3 merupakan pengembangan dari versi v2.1. Meskipun sebagian besar fungsinya masih mirip, namun problem & kelemahan yang muncul di v2.1 telah diperbaiki. Selain itu, v3 menggunakan konsep & mekanisme yang benar-benar baru.
Pada v3, AyaPingPing adalah sebuah package—serta menawarkan mekanisme custom plugin dan built in plugin. Kita bisa membuat plugin sendiri atau menggunakan built in plugin yang sudah tersedia. Package ayapingping-js juga hadir dengan beragam built in functions. Nantinya, fungsi-fungsi tersebut kita pakai untuk mengatur jalannya aplikasi. Setiap proses dari fungsi ayapingping-js yang dipanggil tidak akan langsung dijalankan, melainkan akan didaftarkan dulu kedalam sebuah stack sampai ada fungsi listen atau executor function yang dipanggil. Executor function digunakan untuk menjalankan semua proses yang ada dan terdaftar di dalam stack.
ayapingping-js tersedia di NPM package manager. Untuk menginstall, pertama buat dulu folder project Anda dan masuk kedalam folder tersebut:
mkdir my-project
cd my-projectKemudian, install ayapingping-js dengan perintah berikut:
npm install ayapingping-jsSetelah proses install berhasil, eksekusi perintah berikut untuk membuat working directory dari ayapingping-js:
./node_modules/.bin/ayapingping-js-createPerintah diatas akan membuat folders dan files baru seperti: app.js, .env, controllers, dll yang dibutuhkan untuk memulai menggunakan ayapingping-js.
Gunakan perintah berikut untuk melakukan update ayapingping-js ke versi yang terbaru:
npm update ayapingping-jsayapingping-js berbasis ExpressJS. Bagi yang familiar dengan ExpressJS tentu akan lebih mudah. Untuk menggunakan ayapingping-js, silahkan install terlebih dahulu sesuai dengan petunjuk installasi diatas. Masuk ke folder project Anda, kemudian buka terminal baru dan eksekusi file app.js menggunakan perintah berikut ini untuk menjalankan aplikasi:
node app.jsAnda juga bisa menggunakan pm2 untuk menjalankan ayapingping-js. Contoh:
pm2 start app.jsJika berhasil, maka akan muncul keterangan "Application is live!" seperti ini:
Anda kemudian dapat melakukan request ke url dan port tersebut—Anda juga bisa test dengan membuka browser ke -> http://localhost:3000.
Anda bisa membuat route sederhana di app.js dengan format seperti berikut:
appjs.get('/my-route', 'myRouteController');Kemudian, di folder controller buat file bernama myRouteController.js dan isikan:
'use strict';
module.exports = function(proto, req, res, next) {
res.send('Hello world!');
};Route baru berhasil dibuat. Jika Anda mengakses route GET '/my-route', maka Anda akan mendapatkan response "Hello world!".
ayapingping-jsadalah controller-based. Jadi setiap route harus memiliki controller untuk menghandle logic utamanya.
Anda juga bisa membuat route di app.js dengan gaya ExpressJS seperti berikut ini:
appjs.express((proto, app) => {
// ExpressJS style
app.get('/my-route', (req, res, next) => {
res.send('Hello world!');
});
app.get('/my-route-2', (req, res, next) => {
res.send('Hello world! Again!');
});
});Secara default ayapingping-js membagi tempat kerja menjadi bagian-bagian berikut:
-
app.jsFile utamaayapingping-jsuntuk start/listen/mengatur jalannya aplikasi.app.jsmerupakan tempat untuk membuat routes, me-load plugins dan fungsi-fungsi aplikasi. -
.envFile untuk konfigurasi environment variables. -
controllersFolder untuk menaruh file-filecontrollerdari routes yang Anda buat. -
middlewares(OPTIONAL) Folder untuk menaruh file-filemiddlewaredari routes yang Anda buat.middlewaredisini bersifat optional, karena Anda boleh membuat route tanpamiddleware. -
models(OPTIONAL) Folder untuk menaruh file-filemodeldatabase, misalnya: Sequelize model untuk MySQL atau Mongoose model untuk Mongo.modeldisini bersifat optional, karena Anda mungkin menggunakan mekanisme raw daripada model database, atau Anda mungkin tidak menggunakan database sama sekali. -
plugin(OPTIONAL) Folder untuk menaruh file-filepluginyang Anda buat (custom plugin).plugindisini bersifat optional, karena Anda mungkin tidak menggunakan custom plugin sama sekali. -
public(OPTIONAL) Folder untuk menaruh file-file statis.publicdisini bersifat optional, karena Anda mungkin tidak menggunakan file-file statis.
File utama ayapingping-js untuk mengatur jalannya aplikasi adalah file app.js. Disinilah tempat kita inisialisasi fungsi-fungsi ayapingping-js, membuat routes, listen aplikasi, me-load plugin, dan lain sebagainya. app.js juga adalah file yang dieksekusi untuk menjalankan aplikasi. Untuk menggunakan fungsi ayapingping-js, Anda harus inisialisasi modulnya terlebih dahulu. Silahkan buka file app.js, kemudian gunakan script berikut (lihat contohnya di app.js):
const appjs = require('ayapingping-js')(__dirname);Script diatas akan menginisialisasi & mengunggah fungsi-fungsi bawaan ayapingping-jssehingga dapat diakses secara public. Pada script diatas, fungsi-fungsi tersebut disimpan kedalam variable appjs. Anda kemudian dapat memanggil fungsinya dengan mengakses objeknya, misalnya:
appjs.get('/example');
(__dirname)bersifat required, dan diperlukan oleh sistemayapingping-jsuntuk mendapatkan root path dari aplikasi yang dibuat.
Berikut adalah fungsi-fungsi bawaan ayapingping-js yang tersedia dengan kegunaannya masing-masing:
env()set()load()get()post()put()delete()group()express()listen()
Environment variables menentukan bagaimana sistem aplikasi berjalan tergantung pada jenis environment server atau komputer yang dipakai. ayapingping-js memiliki 3 environment variables utama berikut ini yang digunakan ketika aplikasi di start:
NODE_ENV=development
SERVICE_NAME=AyaPingPing JS
PORT=3000
Environment variables di ayapingping-js disimpan didalam file .env. Anda harus membaca dan me-load file .env pada saat aplikasi di start agar sistem dapat menggunakan variable-variablenya. Ada banyak cara, tapi Anda bisa melakukan hal ini dengan memanggil fungsi environment variables setelah inisialisasi ayapingping-js system: (lihat contohnya di app.js)
appjs.env();Sangat direkomendasikan menjalankan fungsi untuk membaca file .env setelah inisialisasi ayapingping-js. Contoh:
const appjs = require('ayapingping-js')(__dirname);
appjs.env();
// Some stuff...NODE_ENV mengatur mode environment aplikasi yang sedang berjalan, default: "development". Untuk merubah environment aplikasi ke mode production, ubah nilai NODE_ENV menjadi "production":
NODE_ENV=production
NODE_ENVdipakai oleh ExpressJS untuk menentukan environment aplikasi.Selalu gunakan mode
productionapabila Anda ingin melakukan deployment ke arsitektur atau environment production.
SERVICE_NAME adalah nama dari aplikasi ayapingping-js, default: "AyaPingPing JS". Anda bisa merubahnya sesuai dengan nama aplikasi yang sedang Anda buat, misalnya:
SERVICE_NAME=My Application
SERVICE_NAMEdipakai untuk beberapa hal di dalam sistem aplikasi, misalnya: nama aplikasi yang ditampilkan diconsole.
PORT menentukan port yang akan di listen pada saat aplikasi dijalankan, default: "3000". Anda bisa merubah pengaturan portnya sesuai dengan kebutuhan, misalnya:
PORT=8000
PORTdiperlukan oleh sistem (server) untuk mengidentifikasi proses aplikasi atau service yang sedang berjalan. Jikaporttidak di set, maka akan di set default menjadi "3000".