https://github.com/tilap/api-response

Express middleware API responses in JSON
https://github.com/tilap/api-response

Last synced: over 1 year ago
JSON representation

Express middleware API responses in JSON

• Host: GitHub
• URL: https://github.com/tilap/api-response
• Owner: tilap
• License: mit
• Created: 2015-04-16T22:52:12.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-04-26T16:45:23.000Z (about 11 years ago)
• Last Synced: 2025-02-05T10:34:45.465Z (over 1 year ago)
• Language: JavaScript
• Size: 129 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Api Response Middleware for express

Basic Express middleware to simply output json response for Api, set the http

status code and a default message if none is provided.

Allow to easily send Api response with that json format:

    {

        status: 200,

        message: 'OK',

        data: {

            property: 'value'

        }

    }

Automatically add default message depending on the status if none is provided.

Moreover, set the express res status the same as the json response.

## Install

As it's a very small piece of code, don't think it will be usefull enough to

push it on npm. So, use the github repo

    npm install git+https://git@github.com/tilap/api-response.git#v1.0.1

## Usecase

    var express = require('express');

    var app = express();

    var apiResponse = require('api-response');

    app.use( apiResponse.express );

    app.get('/api/ok',function(req,res){

       res.apiResponse(200, {property: 'value'}, 'A custom message');

    });

    app.get('/api/ok',function(req,res){

       res.apiResponse(200, {property: 'value'}, 'A custom message');

    });

    app.listen(8080);