standard-api-response

Generic API response object for consistent API output across services

Standard API Response

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.

app.post('/users', function(reqres) {
// 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);
}
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
}