Code Monkey home page Code Monkey logo

ex-route's Introduction

ex-route

Node.JS route manager.

Installation

npm:

$ npm install ex-route

Options

var route = require('ex-route');
route(app, {
  src: require('path').join(__dirname, '/routes'),
  help: '/api/help',
  debug: true
}, callback);

Examples

Routes

module.exports = [
  /**
   * Get users list
   * @name /api/users
   * @method get
   * @return {Array}
   * @authentication
   */
  {
    method: 'get',
    options: '/api/users',
    callback: function (req, res) {
      res.send([{name: 'respond with a resource'}]);
  },
  /**
   * Get user object by id
   * @name /api/users/:id
   * @method get
   * @param {{id:Integer}} UserId
   * @param {{name:Integer}} UserName
   * @return {Object}
   * @authentication
   */
  {
    method: 'post',
    options: '/api/users',
    callback: function (req, res) {
      res.send({id: req.params.id, name: 'username' + req.params.id});
    }
  }
];

Running Tests

$ npm run-script test

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.