responsify-requests

A small-sized library for handling the response of your APIs, in a well structured way. This library will form a response to your api by having some parameters in function call.

Installation

Install this package with npm

1 $ npm install responsify-requests

Parameters

Parameter	Type	Description
res	object	Required. Response object of your api.
data	object	Required. Data to show on success.
status	number	Required. Status of your response (0 on failure and 1 on success).
message	string	Required. Certain message to show on api call.
response	string	Required. Allowed Values [SUCCESS], [UNAUTHORIZED], [NOT_FOUND], [BAD_REQUEST], [TOO_MANY_REQUESTS], [UNPROCESSABLE_ENTITY]

Status codes

response (parameter)	Status Code
SUCCESS	200
UNAUTHORIZED	401
NOT_FOUND	404
BAD_REQUEST	400
TOO_MANY_REQUESTS	429
UNPROCESSABLE_ENTITY	422

Note

If you do not pass any response parameter to method, Then it will consider as "Internal Server Error" with status code of 500.

Usage/Examples

1const response = require('responsify-requests');
2
3app.get('your_url', (req,res)=> {
4    try {
5    
6    // if you want to send this data as response...
7
8        let data = {
9            id: 1,
10            name: "XYZ"
11        }
12        return response(res, data, 1, "Data recieved succesfully", "SUCCESS");
13    } catch (e) {
14        return response(res, {}, 0, "Error occured", "BAD_REQUEST");
15    }
16})

Output Format

Success Response

1{
2    "message" : "Data recieved succesfully",
3    "data" : {
4        "id": 1,
5        "name": "XYZ"
6    },
7    "status": 1
8}

Failure Response

1{
2    "message" : "Error occured",
3    "status": 0
4}