Response Formatting Library

Installation

npm i [email protected]:mtr-platform/libs/response.git#v1.1.1

Penggunaan

Deklarasikan module library yang ingin digunakan

const { response, responseValid } = require('mtr-response');

Nama Module | Keterangan --- | --- response | Formatting umum   | response(httpCode [Int], dataToPass [Int/String/Array/Object], res, quest [Object/Boolean]);   | daftar httpCode sesuai https://en.wikipedia.org/wiki/List_of_HTTP_status_codes responseValid | Formatting untuk validator   | responseValid(err [Object], res, next);

response

const data = { name: 'User Name', email: '[email protected]', status: '1' };
return response(200, data, res);

{
  "status": 200,
  "message": "OK",
  "value": {
    "name": "User Name",
    "email": "[email protected]",
    "status": "1"
  }
}

responseValid

checkBody(req, { ... });
const err = req.validationErrors(true);
return responseValid(err, res, next);

{
  "status": 422,
  "message": "Unprocessable Entity",
  "error": {
    "email": {
      "isEmail": true,
      "value": "notEmail.id"
    },
    ...
  }
}

quest

Untuk dapat menggunakan fitur Quest perlu didefinisikan SVC_QUEST dan SVC_QUEST_METHOD pada file .env

SVC_QUEST=http://quest-service.development.svc.cluster.local/quest/quest
SVC_QUEST_METHOD=post

Lalu tambahkan contoh potongan code berikut pada endpoint yang akan menggunakan fitur Quest Fitur ini sendiri hanya dapat dijalankan bila terdapat query param ?quest=1 atau ?quest=true

https://dev.svcgateway.meteor.asia/transaction?quest=1

// Contoh data yang ada pada endpoint
const data = {
  id: 'c69b6e5c-3079-11eb-adc1-0242ac120002',
  category_id: 'd3d4986e-3079-11eb-adc1-0242ac120002',
  prod_type: 'dbeb2aae-3079-11eb-adc1-0242ac120002',
  qty: 5,
  total: 500000,
};
// ==================
//    QUEST READY
// ==================
const { headers, query } = req;
let quest = false;
if (query.quest !== undefined) {
  const { quest: q } = query;
  if (q || q === 'true' || q === 1 || q === '1') {
    const { 'x-app-key': appKey, authorization: auth } = headers;
    quest = {
      // Mandatory
      // =========
      appKey,
      srcUrl: '/transaction', // Sesuai dengan endpoint
      srcMethod: 'post',      // Sesuai dengan endpoint
      auth,
      // =========
      // Dynamic data yg dapat digunakan sbg param pengecekan atau param goal
      prod_type: data.prod_type,
      total: data.total,
    };
  }
}
return response(200, data, res, quest); // Ada penambahan param quest

quest turunan

Fitur Quest hanya dapat dipicu melalui akses publik, misal pada contoh di atas.
Kemudian bagaimana bila API yang akan menggunakan fitur ini adalah API gateway yang hanya dapat diakses secara internal melalui code?
Hal ini dapat dilakukan dengan menambahkan query param ?quest_gw=1 atau ?quest_gw=true pada API publik yang didalamnya terdapat API gateway tersebut.
Misal:

https://dev.svcgateway.meteor.asia/transaction?quest_gw=1

Maka perlu ditambahkan contoh potongan code berikut

// ==================
//    QUEST READY
// ==================
const { query } = req;
if (query.quest_gw !== undefined) {
  const { quest_gw: q } = query;
  if (q || q === 'true' || q === 1 || q === '1') {
    await axios({
      method: 'put',
      // Tambahkan query param ?quest=1 atau ?quest=true
      baseURL: 'http://quest-service.development.svc.cluster.local/product-gateway/product?quest=1',
      headers: ...,
      data: ...,
      ...,
    })
  }
}