standard-api-response

Generic API response object for consistent API output across services

npm install standard-api-response
9 downloads in the last day
53 downloads in the last week
216 downloads in the last month

Standard API Response

Build Status

This is a generic API response object for consistent API output across services. it is mostly meant for internal InterNACHI use, but anyone is welcome to use it.

Basic Usage

app.post('/users', function(req, res) {
    // Handle provided data and build new user object
    // ...

    // Create API response object
    var apires = new OkResponse(user, OkResponse.codes.CREATED, 'User successfully created.');

    // Send to client
    apires.send(res);
}

Response Format

HTTP/1.1 201 OK
Content-Type: application/json

{
    "ok": true,
    "message": "User successfully created.",
    "data": { ... },
    "httpCode": 201, // Same as HTTP response code
    "error": { ... } // Only present if "ok" == false
}
npm loves you