NodeJS仿WebApi路由示例

用过WebApi或Asp.net MVC的都知道微软的路由设计得非常好，十分方便，也十分灵活。虽然个人看来是有的太灵活了，team内的不同开发很容易使用不同的路由方式而显得有点混乱。 不过这不是重点，我在做Node项目的时候就觉得不停的用

use(...)

来指定路由路径很烦人，所以用

Typescript

写了这个基于

Koa

和

Koa-router

的路由插件，可以简单实现一些类似WebApi的路由功能。

目标是和WebApi一样:

1.加入的controller会自动加入路由。

2.也可以通过path()手动指定路由。

3.可以定义http method， 如

GET

或

POST

等。

4.Api的参数可以指定url里的query param、path param以及body等。

包已经上传到npm中，npm install webapi-router 安装，可以先看看效果：

第一步，先设置controllers的目录和url的固定前缀

所有的controller都在这目录下，这样会根据物理路径自动算出路由。 url的固定前缀就是host和路由之间的，比如

localhost/api/v2/user/name

，

api/v2

就是这个固定前缀。

import { WebApiRouter } from 'webapi-router';
app.use(new WebApiRouter().router('sample/controllers', 'api'));

第二步是controller都继承自

BaseController

export class TestController extends BaseController
{
}

第三步给controller的方法加上装饰器

@POST('/user/:name')
postWithPathParam(@PathParam('name') name: string, @QueryParam('id') id: string, @BodyParam body: any) {
  console.info(`TestController - post with name: ${name}, body: ${JSON.stringify(body)}`);
  return 'ok';
}

@POST

里的参数是可选的，空的话会用这个controller的物理路径做为路由地址。

:name

是路径里的变量，比如

 /user/brook

,

:name

就是

brook

，可以在方法的参数里用@PathParam得到

@QueryParam

可以得到

url

里

?

后的参数

@BodyParam

可以得到