Skip to content

Latest commit

 

History

History
557 lines (422 loc) · 10.4 KB

readme.md

File metadata and controls

557 lines (422 loc) · 10.4 KB
Raw

Mockable Express

Open Source Express Server for mocked services. Mock your services and test as you wish

Before install

You have to have node js installed in your computer. 'https://github.com/nodesource/distributions/blob/master/README.md'

installation

  1. download or clone from the https://github.com/kwar0715/mockableExpress
  2. open the project
  3. Install yarn 'https://linuxize.com/post/how-to-install-yarn-on-ubuntu-18-04/'
  4. run yarn install
  5. run the project by using below commands
  • yarn yarn start or on custom port yarn start 80
  1. docker command
  • build docker build . -t <name>
  • run docker run -p 80:80 <name> (if run in detached mode use -d)

Usage

  1. goto mocakble express url Default Port is 3000
  2. when you run the server first, You should change the default password. type username as user and password as 12345678
  3. reset password
  4. enjoy :-)

Run on the detached mode

we use pm2 process manager to run mockableExpress in detached mode.

  1. install
npm install pm2 -g
  1. Export Variables
export HOST='your host'
export API_PORT='your port'
  1. start mockable express
#goto mockable express root
pm2 start index.js

Authorization

Mockable express is providing token based authentication for endpoints,

  1. click on the menu icon on right side and create token
  2. create new domain and path,
  3. in the path creation view, enable the Authorization check box
  4. Add authentication to your header.
  5. Keep token safe.

Customizable Responses

  1. You can pass your true data as url parameters and make the custom responses

As an example your url can be like below one

URL parameters

<host>/users/:userID

QUERY parameters

<host>/users/?userID=123456

Body parameters

  {
    "userID":"123456"
  }

then your response can be customized by the url paramter

{
  Id : {{userID}},
  Name: "Name"
}

then Id can be changed according to the userID parameter

Custom Database Actions

You can use your own database to save and retrive your mocked data temporarly.

save your data on database

{
  #save("<your key >","<your value>")#
}

save with parameters,

you are passing a value as URL, Query, Body parameter. you can add you parameter as below,

url : /users/:id/:value

{
  #save("{{id}}","{{value}}")#
}

get your data from database

{ 
  value: #get("<your key >")# 
}{

}

you are passing a value as URL, Query, Body parameter. you can retrieve your data as below,

url : /users/:id

{
  value: #get("{{id}}")#
}

create a random number

#random(minimum,maximum,number of decimal points)#

you can create a random number between 0 and 10 and round off to 2 digits.

#random(0,10,2)#

delete your data from database

#del("<your key >")#

you are passing a value as URL, Query, Body parameter. you can retrieve your data as below,

url : /users/:id

#del("{{id}}")#

Conditional Response

You can return difference response according to a condition.

#if("value1",<operator>,"value2"){
response
}endif

value1 and value2 are compaired by the operator what you are using, if the value1 and value2 are satisfied by the comparison, so only the below response will be returened.

operators

Operator Discription
= equal to
!= not equal
> greater than
< less than
>= greater than or equal to
<= less than or equal to
*< starts With
*> ends With

Ex:- suppose you need to send A if userId equals to 10, unless you need to send B as the response

url : /users/:id

#if("{{id}}",=,"10"){
  A
}endif
B

you can add json object in the response

#if("{{id}}",=,"10"){
  {
    value: "A"
  }
}endif
 {
    value: "B"
 }

Iterative Response

You can generate your response from iterative manner. if you want to repeate something you can use this syntax.

#for("<Count>"){
<Repeatable part>
}endfor

suppose you need to pring "Hello" 10 times,

#for("10"){
Hello
}endfor

then your response will be

HELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLOHELLO

add to json response

{
"value": "#for("10"){
Hello
}endfor"
}

Array Iterative Response

You can make the response according to the array of comma seperated response. your body, query parameter can be a comma seperated array or string,

body param:

{
 "arr": [1,2,3,4,5]
}
or 
{
 "arr": "1,2,3,4,5"
}

query param:

<host>/path?arr=1,2,3,4,5

usage can be

#foreach("[1,2,3,4,5]","ele"){
{{ele}}
}endforeach

element iterative element and you can use any name.

result will be

[1,2,3,4,5]

you can use this in json object.

{
"value":#foreach("[1,2,3,4,5]","ele"){
{{ele}}
}endforeach
}

so the response can be,

{
    "value": [
        1,
        2,
        3,
        4,
        5
    ]
}

Set Customized Status Code

You can set your response status in your code.

#setStatus(400)#

You can use this in if conditions.

#if("{{id}}",=,"10"){
  #setStatus(400)#
  A
}endif
B

If you send id=10 so you will receive status 400 A Response. unless you will get the common status you saved by the UI.

Constants allocation

You can define a constants in the response body. you can only pass strings and digits for the constant.

allocation

!<variable name>=<value>!

usage

!<variable name>

suppose you need to make a constant called data and value on data should be printed twise.

!data=hello!

!data
!data

Comments

You can comment on your reponse.

/*
comment string
*/

Environment Variables

You can set environment variables here. click on more button.

#env("VARIABLE_NAME")#

JS programming console

You can use javascript language for logic development. Write your logic and run it.

#prog{
    var count = {{count}}
    return JSON.stringify({
        "returnValue": count + 1
    });
}endprog

{
"hello": #prog_value#
}

Http requests

Mockable express is using node-fetch library for execute http communication.

#prog{
    await fetch('https://httpbin.org/post', {
            method: 'post',
            body:    JSON.stringify(body),
            headers: { 'Content-Type': 'application/json' },
        })
    return 'OK';
}endprog

{
"hello": #prog_value#
}

Use of environment variables

#prog{
    const variableValue = "#env("ENV")#"
    return 'OK';
}endprog

{
"hello": #prog_value#
}

Other useful libraries

We use below libraries for extend usability of code.

  1. lodash = https://lodash.com/
  2. moment = https://momentjs.com/
  3. path = https://nodejs.org/docs/latest/api/path.html
  4. underscore = https://underscorejs.org/
  5. faker = https://www.npmjs.com/package/Faker
#prog{
    
    const value = lodash.add(1,2);
    const time = moment()
    const underscore = underscore.find([1, 2, 3, 4, 5, 6], function(num){ return num % 2 == 0; })
    const data =  faker.name.findName()
}endprog

Create Your Endpoints Programmatically

You can create endpoints programmatically from upload endpoint. so first you have to enable the upload functionality. goto ** Menu Bar -> Enable Upload**

url : <host>/admin/upload
method : post
headers : Content-Type : application/json
body :{
  [
    {
      "domainName":"testDomain1",
        "pathName":"testPath1",
        "pathUrl":"/testPath1",
        "pathDescription": "testPath1",
        "header":{},
        "pathMethod":"post",
        "pathStatus": 200,
        "body":"testPath1"
    },
    {
      "domainName":"testDomain2",
        "pathName":"testPath2",
        "pathUrl":"/testPath2",
        "pathDescription": "testPath1",
        "header":{},
        "pathMethod":"get",
        "pathStatus": 200,
        "body":"#if(\"{{id}}\",=,\"10\"){{\"value\": \"A\"}}endif{\"value\": \"B\"}"
    },
    {
      "domainName":"testDomain3",
        "pathName":"testPath3",
        "pathUrl":"/testPath3",
        "pathDescription": "testPath3",
        "header":{},
        "pathMethod":"get",
        "pathStatus": 200,
        "body": "{\"messsage\":\"hello\"}"
    }
  ]
}

Create Your Endpoints Programmatically - Dynamic Responses from Query Parameter

You can change your response by query parameter without do any if else syntax. this is enabled only for upload method.

[
  {
    "domainName": "testDomain1",
    "pathName": "testPath1",
    "pathUrl": "/testPath1",
    "pathDescription": "testDiscripion",
    "header":{},
    "pathMethod": "GET",
    "pathStatus": 200,
    "query": {
 	    "parameter":"status",
 	    "value":"test1",
            "operator":"!=",  // default is =. this is optional
 	    "body":{
 		    "message":"hello"
 	    }
    },
    "body": "#Query"
  }
]

#Query segment will replaced by the filtered query.

"parameters": [ // one query parameter
  {
    "condition": "templete", // parameter condition 
    "value": "templete2"   // parameter value that will pass from the above parameter to show
  }
]

Templete 1 will received for testDomain1/testPath1?templete=templete1 Templete 2 will received for testDomain1/testPath1?templete=templete2

Limitations

  1. Query params should not contain '+' charactor. is it is necessary, it should be changed in the conditions as ' '

Ex:-

Url: /test?count = 10+10

#if("{{count}}",=,"10 10"){
  {
    value: "Query params are 10+10"
  }
}endif

Mocked WebSocket

You can use mockable express serer as mocked web socket server. go to socket tab and connect your web socket client to Socket URL. Send your message to connected client

Technologies

  1. Node JS : https://nodejs.org/en/
  2. Express Server : https://expressjs.com/
  3. EJS : https://ejs.co/
  4. JSON-DB : https://github.com/Belphemur/node-json-db
  5. Winston Logger : https://github.com/winstonjs/winston
  6. Bootstrap : https://getbootstrap.com/
  7. Jquery : https://jquery.com/

Contribution

  1. Kolitha Warnakulasooriya
  2. Pravinda Perera
  3. Sameera Jayawardana
  4. Kasun Kodithuwakku