koa-router

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.

Named routes

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

点击(此处)折叠或打开

router.get('user', '/users/:id', function *(next) {
// ...
});
router.url('user', 3);

Multiple middleware

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" }
}
);

Nested routers

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());

Router prefixes

Route paths can be prefixed at the router level:

点击(此处)折叠或打开

var router = new Router({
prefix: '/users'
});
router.get('/', ...); // responds to "/users"
router.get('/:id', ...);

URL parameters

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

Param	Type	Description
path	String
[middleware]	function	route middleware(s)
callback	function	route callback

router.routes ? function

Returns router middleware which dispatches a route matching the request.

Kind: instance property of Router

router.use([path], middleware, [...]) ? 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

Param	Type
[path]	String
middleware	function
[...]	function

Example

点击(此处)折叠或打开

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

router.prefix(prefix) ? Router

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

Kind: instance method of Router

Param	Type
prefix	String

Example

点击(此处)折叠或打开

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

router.allowedMethods([options]) ? function

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

Param	Type	Description
[options]	Object
[options.throw]	Boolean	throw error instead of setting status and header
[options.notImplemented]	Function	throw the returned value in place of the default NotImplemented error
[options.methodNotAllowed]	Function	throw the returned value in place of the default MethodNotAllowed error