KoaHub平台基于Node.js开发的router路由插件代码
程序员文章站
2022-05-06 19:57:51
...
KoaHub平台基于Node.js开发的Koa router路由插件代码信息详情
koa-router
Router middleware for koa. Provides RESTful resource routing.
koa-router
Router middleware for koa[list][*]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).[/list]koa 2.x
See koa-router 7.x for koa 2.x and async/await support.
Installation
Install using npm:
[*]Router ⏏
[*]new Router([opts])
[*]instance
[*].get|put|post|patch|delete ⇒ Router
[*].param(param, middleware) ⇒ Router
[*].use([path], middleware, [...]) ⇒ Router
[*].routes ⇒ function
[*].allowedMethods([options]) ⇒ function
[*].redirect(source, destination, code) ⇒ Router
[*].route(name) ⇒ Layer | false
[*].url(name, params) ⇒ String | Error
[*]static
[*].url(path, params) ⇒ String[/list]Router
Kind: Exported class
new Router([opts])
Create a new router.
[table=50%]
Param
TypeDescription
[opts]
Object
[opts.prefix]
String
prefix router paths
[/table]Example Basic usage:
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() or router.post().
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.
Multiple middleware may be given:
Nesting routers is supported:
Route paths can be prefixed at the router level:
Named route parameters are captured and added to ctx.params.
[table=50%]
Param
Type
Description
path
String
[middleware]
function
route middleware(s)
callback
function
route callback
[/table]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
[table=50%]
Param
Type
[path]
String
middleware
function
[...]
function
[/table]Example
Set the path prefix for a Router instance that was already initialized.
Kind: instance method of Router
[table=50%]
Param
Type
prefix
String
[/table]Example
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
[table=50%]
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
[/table]Example
Redirect source to destination URL with optional 30x status code.
Both source and destination can be route names.
[table=50%]
Param
Type
Description
source
String
URL or route name.
destination
String
URL or route name.
code
Number
HTTP status code (default: 301).
[/table]router.route(name) ⇒ Layer | false
Lookup route with given name.
Kind: instance method of Router
Param Type
name String
router.url(name, params) ⇒ String | Error
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
koa-router
Router middleware for koa. Provides RESTful resource routing.
koa-router
Router middleware for koa[list][*]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).[/list]koa 2.x
See koa-router 7.x for koa 2.x and async/await support.
Installation
Install using npm:
npm install koa-router
API Reference[list][*]koa-router[*]Router ⏏
[*]new Router([opts])
[*]instance
[*].get|put|post|patch|delete ⇒ Router
[*].param(param, middleware) ⇒ Router
[*].use([path], middleware, [...]) ⇒ Router
[*].routes ⇒ function
[*].allowedMethods([options]) ⇒ function
[*].redirect(source, destination, code) ⇒ Router
[*].route(name) ⇒ Layer | false
[*].url(name, params) ⇒ String | Error
[*]static
[*].url(path, params) ⇒ String[/list]Router
Kind: Exported class
new Router([opts])
Create a new router.
[table=50%]
var app = require('koa')();
var router = require('koa-router')();
router.get('/', function *(next) {...});
app
.use(router.routes())
.use(router.allowedMethods());
router.get|put|post|patch|delete ⇒ RouterCreate 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() or router.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);
// => "/users/3"
Multiple middlewareMultiple 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 routersNesting 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 prefixesRoute 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"
URL parametersNamed 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[table=50%]
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
[table=50%]
router.use(session(), authorize());
// use middleware only with given path
router.use('/users', userAuth());
app.use(router.routes());
router.prefix(prefix) ⇒ RouterSet the path prefix for a Router instance that was already initialized.
Kind: instance method of Router
[table=50%]
router.prefix('/things/:thing_id')
router.allowedMethods([options]) ⇒ functionReturns 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
[table=50%]
var app = koa();
var router = router();
app.use(router.routes());
app.use(router.allowedMethods());
Example with Boom
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()
}));
router.redirect(source, destination, code) ⇒ RouterRedirect 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[table=50%]
Lookup route with given name.
Kind: instance method of Router
Param Type
name String
router.url(name, params) ⇒ String | Error
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
推荐阅读
-
基于 Koa平台Node.js开发的KoaHub.js连接打印机的代码
-
基于 Koa平台Node.js开发的KoaHub.js的跳过组件代码
-
KoaHub平台基于Node.js开发的router路由插件代码
-
基于 Koa平台Node.js开发的KoaHub.js的跳过组件代码
-
KoaHub基于Node.js开发的连接支付宝插件代码信息详情
-
基于Koa平台Node.js开发的KoaHub控制器,模型,自动加载
-
KoaHub.JS基于Node.js开发的Koa 生成验证码插件代
-
基于 Koa平台Node.js开发的KoaHub.js连接打印机的代码
-
KoaHub基于Node.js开发的Koa EJS渲染插件代码信息详情
-
KoaHub平台基于Node.js开发的router路由插件代码