Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kisiwu/novice-routing
A small extension of Express routing.
https://github.com/kisiwu/novice-routing
express middleware router routing
Last synced: 9 days ago
JSON representation
A small extension of Express routing.
- Host: GitHub
- URL: https://github.com/kisiwu/novice-routing
- Owner: kisiwu
- License: mit
- Created: 2020-01-05T00:39:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-10T15:58:13.000Z (about 1 month ago)
- Last Synced: 2024-10-27T17:28:11.354Z (19 days ago)
- Topics: express, middleware, router, routing
- Language: JavaScript
- Homepage:
- Size: 322 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @novice1/routing
A small extension of [Express routing](https://expressjs.com/en/guide/routing.html).
## Installation
```bash
$ npm install @novice1/routing
```
## Usage
It keeps all the functionalities of Express router and extends them.
### Router
A JSON object can be sent as the `path` parameter when using route methods (`get`, `post`, ...), `all` and `route`. That object must have the property `path` and can also have the following properties:
- `name`: (string)
- `description`: (string)
- `parameters`: (object)
- `responses`: (any)
- `tags`: (string[])
- `auth`: (boolean)
- `preValidators`: (function[])
Example:
```js
var router = require('@novice1/routing')()
router.get({
path: '/',
name: 'Home',
description: 'Home page',
parameters: {
// ...
},
responses: {
// ...
},
tags: ['Index']
}, function (req, res) {
// information about the current route
// can be found at req.meta
res.json(req.meta)
})
```
### Auth
From those properties, only `path` and `auth` influence the routing.
When you need to verify the client's authentication the same way for a router's route, you can set middlewares with the method `setAuthHandlers`. Those middlewares will only be executed for routes with `auth` set to `true`.
```js
var router = require('@novice1/routing')()
// set middleware(s) to handle authentication
router.setAuthHandlers(function (req, res, next) {
// do something
next()
}, function (req, res, next) {
// do something else
next()
})
router.get({
name: 'Home',
path: '/'
}, function (req, res) {
res.send('hello world')
})
router.get({
auth: true, // handle the authentication for this route
name: 'Management',
path: '/admin'
}, function (req, res) {
res.send('hello admin')
})
```
`setAuthHandlers` can be called before or after creating the routes.
### Validators
You can use `setValidators` to set handlers that valid the client's request.
Those middlewares have access to `req.meta` so you could make use of the property `parameters` for example.
```js
var router = require('@novice1/routing')()
router.get({
name: 'Main app',
// set parameters
parameters: {
query: {
version: "number" // e.g.: the type that the query variable 'version' should have
}
},
path: '/app'
}, function (req, res) {
res.json(req.meta)
})
// check requests for this router
router.setValidators(function (req, res, next) {
if(req.meta.parameters.query.version == 'number') {
if(!isNaN(req.query.version)) {
// ok
next()
} else {
// client's request is not valid
res.status(400).send('Bad request')
}
} else {
// ok
next()
}
})
```
`setValidators` can be called before or after creating the routes.
### Other methods
As a router can be a middleware of another router (`use` method), you might want to keep different `auth` and `validator` handlers for some routers. For example a router might have its own `auth` handlers while being `use`d by a router also having `auth` handlers. For that purpose there are some methods:
- `setAuthHandlersIfNone`
- `setValidatorsIfNone`
Example:
```js
var routing = require('@novice1/routing')
var routerChild = routing()
routerChild.get('/', function (req, res) {
res.json(req.meta)
})
routerChild.setValidators(function (req, res, next) {
next()
})
var routerParent = routing()
routerParent.put('/', function (req, res) {
res.json(req.meta)
})
// use 'routerChild' in 'routerParent'
routerParent.use(routerChild)
// set validators for routes except for
// those already having validators
routerParent.setValidatorsIfNone(function (req, res, next) {
next()
})
```
## Notes
### Typescript
This package extends `Request` interface from [express](https://www.npmjs.com/package/express) so you can always extend it more depending on your needs.
Example:
```ts
declare global {
namespace Express {
interface Request {
// add a property
session?: Record;
}
}
}
```
## References
- [Express](https://expressjs.com/)