Skip to content

santoshstha/be_response_api_nodejs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Response API with NodeJS

Make your API nicer and readable, Version 1.0.0

Read more about this code right here

NodeJS - Make your response API nicely

Usage

// Import the responseApi.js file
const { success, error, validation } = require('./responseApi');

// Make a request
app.get('/', async (req, res) => {
  // Do with validation here
  res.status(422).json(validation({username: 'Username is required.'}))

  try {
    // Dome some with success here
    res.status(200).json(success('OK', {user: 'Hi, John Doe.'}, res.statusCode));
  } catch(err) {
    // Do some with error here
    res.status(500).json(error('Something went wrong.', res.statusCode);
  }
});

Example Success Response

{
  "message": "OK",
  "error": false,
  "code": 200,
  "results": {
    "user": "Hi, John Doe."
  }
}

Example Error Response

{
  "message": "Something went wrong",
  "error": true,
  "code": 500
}

Example Validation Response

{
  "message": "Something went wrong",
  "error": true,
  "code": 422,
  "errors": {
    "username": "Username is required"
  }
}

About

Structured NodeJS response API

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%