Oda2 / api-middleware-response

middleware for api http response

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API Middleware Response

Middleware for API HTTP Response

Build Status npm License Coverage Status

Install

$ npm install api-middleware-response --save

Setup

var express = require('express')
var apiresponse = require('api-middleware-response');
var app = express();

app.use(apiresponse());
app.listen(3000);

How to use

Example with object

app.get('/', function(req, res) {
  var data = { 
    id: 10,
    name: "Renato"
  };
  
  res.data.setObject(data);
}

Output

{
    "id": "10",
    "name": "Renato"
}

Example with array object

app.get('/', function(req, res) {
  var data = [
  { 
    "id": "10",
    "name": "Renato"
  },
  { 
    "id": "20",
    "name": "André"
  }
  ];
  
  res.data.setArrayObject(data);
}

Output

{
  "success": "true",
  "paging": {
    "total": "2",
    "pages": "1",
    "currentPage": "1",
    "perPage": "15"
  },
  "data": [
  { 
    "id": "10",
    "name": "Renato"
  },
  { 
    "id": 20,
    "name": "André"
  }
  ]
}

Roadmap

License

Licensed under the MIT License.

About

middleware for api http response

License:MIT License


Languages

Language:JavaScript 69.6%Language:TypeScript 30.4%