See koa-router 7.x for koa 2.x and async/await support.

Install using npm:

npm install koa-router

Kind: Exported class

Create a new router.

Example Basic usage:

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

router.get('/', function *(next) {...});

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

Create router.verb() methods, where verb is one of the HTTP verbes such as router.get() or router.post().

Match URL patterns to callback functions or controller actions using router.verb(), where verb is one of the HTTP verbs such as router.get() orrouter.post().

router
  .get('/', function *(next) {
    this.body = 'Hello World!';
  })
  .post('/users', function *(next) {
    // ...
  })
  .put('/users/:id', function *(next) {
    // ...
  })
  .del('/users/:id', function *(next) {
    // ...
  });

Route paths will be translated to regular expressions using path-to-regexp.

Query strings will not be considered when matching requests.

Routes can optionally have names. This allows generation of URLs and easy renaming of URLs during development.

Multiple middleware may be given:

router.get(
  '/users/:id',
  function *(next) {
    this.user = yield User.findOne(this.params.id);
    yield next;
  },
  function *(next) {
    console.log(this.user);
    // => { id: 17, name: "Alex" }
  }
);

Nesting routers is supported:

var forums = new Router();
var posts = new Router();

posts.get('/', function *(next) {...});
posts.get('/:pid', function *(next) {...});
forums.use('/forums/:fid/posts', posts.routes(), posts.allowedMethods());

// responds to "/forums/123/posts" and "/forums/123/posts/123"
app.use(forums.routes());

Route paths can be prefixed at the router level:

var router = new Router({
  prefix: '/users'
});

router.get('/', ...); // responds to "/users"
router.get('/:id', ...); // responds to "/users/:id"

Named route parameters are captured and added to ctx.params.

router.get('/:category/:title', function *(next) {
  console.log(this.params);
  // => { category: 'programming', title: 'how-to-node' }
});

Kind: instance property of Router

 

Returns router middleware which dispatches a route matching the request.

Kind: instance property of Router

Use given middleware(s) before route callback.

Only runs if any route is matched. If a path is given, the middleware will run for any routes that include that path.

Kind: instance method of Router

 

router.use(session(), authorize());

// use middleware only with given path
router.use('/users', userAuth());

app.use(router.routes());

Set the path prefix for a Router instance that was already initialized.

Kind: instance method of Router

router.prefix('/things/:thing_id')

Returns separate middleware for responding to OPTIONS requests with an Allow header containing the allowed methods, as well as responding with 405 Method Not Allowed and 501 Not Implemented as appropriate.

Kind: instance method of Router

var app = koa();
var router = router();

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

var app = koa();
var router = router();
var Boom = require('boom');

app.use(router.routes());
app.use(router.allowedMethods({
  throw: true,
  notImplemented: () => new Boom.notImplemented(),
  methodNotAllowed: () => new Boom.methodNotAllowed()
}));

Redirect source to destination URL with optional 30x status code.

Both source and destination can be route names.

router.redirect('/login', 'sign-in');

This is equivalent to:

router.all('/login', function *() {
  this.redirect('/sign-in');
  this.status = 301;
});

Kind: instance method of Router

Lookup route with given name.

Kind: instance method of Router

Generate URL for route. Takes the route name and a map of named

wemall  开源微商城 ，微信商城，商城源码，三级分销，微生鲜，微水果，微外卖，微订餐---专业的o2o系统

wemall地址：http://www.wemallshop.com

代码来源：http://js.koahub.com/home/feature/koa-jwt