Is there a Express-style nested router for Koa.js?

Question

Is there exist a library that provides Express-style nesting routers? Something like this:

var koa = require('koa');
var app = koa();
var Router = require('???');

var restApiRouter = Router();
restApiRouter.get('/', function*() {
  // respond to /api/
});
restApiRouter.get('/messages', function*() {
  // respond to /api/messages
});

var appRouter = new Router();
appRouter.get('/', function*() {
  // respond to /
});
// redirects all /api/* requests to restApiRouter
appRouter.use('/api', restApiRouter);

app.use(appRouter);

If there isn't, what is the best practice to incapsulate common path routes in other files?

score 4 · Accepted Answer · answered Jul 14 '15 at 20:10

Previous answer didn't show exactly how to nest routers. Here is a real-world example, splitted in several controller files.

First, we define some API routes into a controllers/api/foo.js file:

var router = require('koa-router')();

router.get('/', function* () {
    // Return a list of foos
});

router.get('/:id', function* () {
    // Return a specific foo
});

module.exports = router;

Then, on your application router, you can embed it like the following, in a file controllers/index.js:

var router = require('koa-router')();

// Create a new route
router.get('/', function* () {
    this.body = 'Home page';
});

// Nest previous API route
router.get('/api/foo', require('./api/foo').routes());

module.exports = router;

Finally, just use the router into your application index.js:

var koa = require('koa');
var app = koa();
app.use(require('./controllers').routes());
app.listen(process.env.PORT || 3000);

score 1 · Answer 2 · answered Apr 15 '15 at 14:30

1

I believe koa-router should do what your needing.

var Router = require('koa-router');

var restApiRouter = new Router({
  prefix: '/api'
});

restApiRouter.get('/', ...); // responds to "/api"
restApiRouter.get('/messages', ...); // responds to "/api/messages"

var router = new Router();
router.get('/', ...); // responds to "/"

app
  .use(restApiRouter.routes())
  .use(router.routes())
  .use(restApiRouter.allowedMethods());
  .use(router.allowedMethods());

answered Apr 15 '15 at 14:30

James Moore

1,881
14
18

is it possible to have my routes in a separate file? – chovy May 17 '15 at 09:39
This is totally not a correct answer, there is no nested router in this example – Alex Lapa Jun 07 '15 at 10:42

mtsdev · Answer 3 · 2016-09-13T01:04:08.080

Well, maybe not exactly as you expect, but, in my experience, koa-router does that job.

I don't have right now any tested code, but it should look like this

main.js

    var app = require('koa')()
    var port = 8080
    var http = require('http')
    var server = http.createServer(app.callback())
    // Import your main Router
    var mainRouter = require('/app/routes/root')

    //and use its routes and methods
    app.use( mainRouter.routes())
    app.use( mainRouter.allowedMethods())

    server.listen(port, function(){
      console.log ('Listening on port %d, App Ready',port)
    })

The Main router definition

/app/routes/root.js

"use strict;"

var router = require('koa-router')();

router.redirect('/', 'index.html')

router.get('/*.html', *blahblah())
 // returns any html on root

// define your admin router here
var adminRouter = require(appRoot+'/app/routes/admin')

// ..and import it into current router
router.use(adminRouter.routes() )
router.use(adminRouter.allowedMethods() )

//  at the end, export myself
module.exports = router

And finally, the Admin section router

/app/routes/admin.js

"use strict;"

// define router here, adding a prefix
var router = require('koa-router')().prefix('/admin/');
// redirect if no file specified
router.redirect('/', 'index.html')

router.get('*.html', function *(next){
    //do your own work
    this.body = something
})

// add More Routes, if needed
router.get('api.html', function *(next){
    if (this.query['status'])
       this.body = statusObject
  
})

// and finally export it
module.exports = router

NOTE: All of the above isn't directly runnable code. It's only a conceptual example

Also note that you can use tons of koa-middleware ( or even write your own: it's not that hard) that maybe could affect koa-router behaviour

Is there a Express-style nested router for Koa.js?

3 Answers3