Routers for eggjs by decorator pattern.
npm install egg-router-decoratorbash
npm install --save egg-router-decorator
`
$3
In router.ts or route.js
`ts
// router.ts or route.js
import { Application } from 'egg';
import { initRouter } from 'egg-router-decorator';
export default (app: Application) => {
initRouter(app);
}
`
Prefix Url Globally
`js
// router.ts or router.js
initRouter(app, { prefix: '/api' })
// controller.ts or controller.js
export default class index extends Controller {
@routerDecorator.get('/user') //===>>/api/user
async get() {
this.ctx.body = 'hello, egg-router-decorator.'
}
}
`
Prefix Url For Controller
`js
// controller.ts or controller.js
import routerDecorator from 'egg-router-decorator';
@routerDecorator.prefix('/home')
export default class home extends Controller {
@routerDecorator.get('/test') //===>>/home/test
async get() {
this.ctx.body = 'hello, egg-router-decorator.'
}
}
`
Router Middleware
Router middleware will run before the target function.
Example
`ts
import { Controller } from 'egg';
import routerDecorator from 'egg-router-decorator';
// @routerDecorator.prefix('/example')
@routerDecorator.prefix('/example', (ctx, next) => {
console.log(ctx.request.URL);
console.log('ExampleController的prefix中的中间件1');
next();
}, async (ctx, next) => {
await next();
console.log(ctx.request.URL);
console.log('ExampleController的prefix中的中间件2');
})
export default class ExampleController extends Controller {
@routerDecorator.get('/index') // ===>>/example/index get
@routerDecorator.post('/index2') // ===>>/example/index2 post
public async test1 () {
const { ctx } = this;
ctx.body = 'hello, egg-router-decorator.'
}
@routerDecorator.put('/parms/:id') // ===>>/parms/:id put
public async test2 () {
const { ctx } = this;
ctx.body = 'hello, egg-router-decorator.'
}
@routerDecorator.del('/parms/:id/:pwd', isLogin, hasDelAuth) // ===>>/parms/:id/:pwd del
public async test3 () {
const { ctx } = this;
ctx.body = 'hello, egg-router-decorator.'
}
}
// isLogin middleware
const isLogin = async (ctx, next) => {
if (ctx.params['id']) {
await next();
} else {
ctx.status = 401;
}
}
// hasDelAuth middleware
const hasDelAuth = async (ctx, next) => {
if (ctx.params['pwd'] === 'admin') {
await next();
// ctx.body = 'xxx'
} else {
ctx.status = 403;
}
}
``