Giter Club home page Giter Club logo

be_response_api_nodejs's Introduction

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"
  }
}

be_response_api_nodejs's People

Contributors

hudaprs avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.