Chinaunix首页 | 论坛 | 博客
  • 博客访问: 52309
  • 博文数量: 48
  • 博客积分: 0
  • 博客等级: 民兵
  • 技术积分: 260
  • 用 户 组: 普通用户
  • 注册时间: 2016-07-12 11:48
文章分类
文章存档

2016年(48)

我的朋友

分类: JavaScript

2016-10-18 18:35:47

koa-router

Router middleware for koa. Provides RESTful resource routing.

     

Router middleware for 

  • Express-style routing using app.get, app.put, app.post, etc.
  • Named URL parameters.
  • Named routes with URL generation.
  • Responds to OPTIONS requests with allowed methods.
  • Support for 405 Method Not Allowed and 501 Not Implemented.
  • Multiple route middleware.
  • Multiple routers.
  • Nestable routers.
  • ES7 async/await support (koa-router 7.x).

See  for koa 2.x and async/await support.

Install using :

点击(此处)折叠或打开

  1. npm install koa-router


    •  ?
      • instance
        •  ? Router
        •  ? Router
        •  ? Router
        •  ? function
        •  ? function
        •  ? Router
        •  ? Layer | false
        •  ? String | Error
      • static
        •  ? String

Kind: Exported class

Create a new router.

Param Type Description
[opts] Object
[opts.prefix] String prefix router paths

Example Basic usage:

点击(此处)折叠或打开

  1. var app = require('koa')();
  2. var router = require('koa-router')();
  3.   
  4. router.get('/', function *(next) {...});
  5.   
  6. app
  7.   .use(router.routes())
  8.   .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().

点击(此处)折叠或打开

  1. router
  2.   .get('/', function *(next) {
  3.     this.body = 'Hello World!';
  4.   })
  5.   .post('/users', function *(next) {
  6.     // ...
  7.   })
  8.   .put('/users/:id', function *(next) {
  9.     // ...
  10.   })
  11.   .del('/users/:id', function *(next) {
  12.     // ...
  13.   });


Route paths will be translated to regular expressions using .

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.

点击(此处)折叠或打开

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


Multiple middleware may be given:

点击(此处)折叠或打开

  1. router.get(
  2.   '/users/:id',
  3.   function *(next) {
  4.     this.user = yield User.findOne(this.params.id);
  5.     yield next;
  6.   },
  7.   function *(next) {
  8.     console.log(this.user);
  9.     // => { id: 17, name: "Alex" }
  10.   }
  11. );


Nesting routers is supported:

点击(此处)折叠或打开

  1. var forums = new Router();
  2. var posts = new Router();
  3.   
  4. posts.get('/', function *(next) {...});
  5. posts.get('/:pid', function *(next) {...});
  6. forums.use('/forums/:fid/posts', posts.routes(), posts.allowedMethods());
  7.   
  8. // responds to "/forums/123/posts" and "/forums/123/posts/123"
  9. app.use(forums.routes());


Route paths can be prefixed at the router level:

点击(此处)折叠或打开

  1. var router = new Router({
  2.   prefix: '/users'
  3. });
  4.   
  5. router.get('/', ...); // responds to "/users"
  6. router.get('/:id', ...);


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

点击(此处)折叠或打开

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


Kind: instance property of 

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

Returns router middleware which dispatches a route matching the request.

Kind: instance property of 

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 

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

Example

点击(此处)折叠或打开

  1. router.use(session(), authorize());
  2.   
  3. // use middleware only with given path
  4. router.use('/users', userAuth());
  5.   
  6. app.use(router.routes());


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

Kind: instance method of 

Param Type
prefix String

Example

点击(此处)折叠或打开

  1. 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 

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

Example

Example with 

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

Both source and destination can be route names.

点击(此处)折叠或打开

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

This is equivalent to:

点击(此处)折叠或打开

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

Kind: instance method of 

Param Type Description
source String URL or route name.
destination String URL or route name.
code Number HTTP status code (default: 301).

Lookup route with given name.

Kind: instance method of 

Param Type
name String

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

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


代码来源:


阅读(943) | 评论(0) | 转发(0) |
给主人留下些什么吧!~~