uno-api v1.2.4

uno-api

simplify express router

#What's New in 1.2.0

• getAllRoutes, for get all list route in uno-api

Boilerplate Uno-Api

This boilerplate using uno-api, you can learn here how to use uno-api

Thanks To: masb0ymas

• boilerplate-express-with-sequelize (https://github.com/masb0ymas/boilerplate-express-with-sequelize)

installing

$ npm install uno-api

Example

var router = express.Router();
const UnoRouter = require('uno-api').Router
const simpleRouter = new UnoRouter(router)
const MiddlewareAuth = require('./controllers/MiddlewareAuth')
const UserController = require('./controllers/UserController')
function mainPage(req, res, next) {
  res.render('index', { title: 'Express' });
}

simpleRouter.create({
	baseURL: '/user',
	get: UserController.getUser,
	getWithParam: [
		[':UserId', UserController.getUserByUserId], //ex: http://localhost:3000/user/1
		[':UserId/:RoleId', MiddlewareAuth.main, UserController.getUserByRoleId] //ex: http://localhost:3000/user/1/5
	],
	post: {
		middleware: MiddlewareAuth.multer([{ name: 'file', maxCount: 1 }]), //or with array [MiddlewareAuth.multer([{ name: 'file', maxCount: 1 }])],
		callback: UserController.createUser
	},
	put: UserController.updateUser,
	delete: UserController.deleteUser,
})

unoAPI

unoApi.Router(config)

config

//example

const simpleRouter = new unoApi.Router({
	title: 'RoutePublic', // this is grouping name routes for getAllRoutes
	baseURL: '', // you can define global baseURL here for this route
	middleware: [Middleware1, Middleware2], // you can define middleware here
	wrapperRequest: wrapperApiPublic // handle all callback by this function, ex: wrapperApiPublic(callback)
})

.Router API

simpleRouter.create(createConfig)

create config

simpleRouter.create({
    title: 'ApiMasterData',
    baseURL: '/master',
    get: myGetFunction, 
    post: [myMiddlewarePost, myPostFunction],
    put: {
      middleware: [myMiddlewarePut],
      callback: myPutFunction,
      overrideMiddleware: true
    },
    delete: [myMiddlewareDelete, myDeleteFunction, UnoApi.OPTIONS.OVERRIDE_MIDDLEWARE], // like put
    getWithParam: [
      [':id', myMiddlewareGetParam, myGetParamFunction], //ex: http://example.com/master/1
      [':id/:userid', myMiddlewareGetParam, myGetParamFunction, UnoApi.OPTIONS.OVERRIDE_MIDDLEWARE], //ex: http://example.com/master/1/299
      ['detail', myMiddlewareGetParam, myGetParamFunction, UnoApi.OPTIONS.OVERRIDE_MIDDLEWARE], //ex: http://example.com/master/detail
    ], // this config same for all route method get, post, put, delete (withParam)
    middleware: [MiddlewareMasterData],
    overrideMiddleware: true, // this will remove all UnoApi.Router middleware only for this API
    wrapperRequest: wrapperRequestMaster // wrapperRequest only for this API master, this will replace wrapperRequest UnoApi.Router
})

method config

method config

simpleRouter.create({
	baseURL: '/public',
	get: {
            middleware: myGetMiddleware,
            callback: myGetFunction,
            overrideMiddleware: true,
            wrapperRequest: wrapperRequestMethod //
	},
	put: {
            middleware: myPutMiddleware,
            callback: wrapperRequestMethod(myPutFunction), //this is same like using wrapperRequest
            overrideMiddleware: true,
	}
})