0.0.7 • Published 6 years ago
roa-restful v0.0.7
roa-restful
实现基于装饰器的koa-router路由定义。
类似基于JAVA的使用注解编程以及面向对象分析世界 。:smile:
安装
npm i --save roa-restful使用
首先定义一个控制器类,对应着koa-router的Router。
const {
Controller,
Get,
Post,
Delete,
Put
} = require("roa-restful)
@Controller("/user")
export class UserController {
@Get("/userInfo")
async (ctx, next) => {
// .....just like that
}
}你可以在项目的任何地方导入你的控制器类,当装饰器运行时,会往控制器类的prototype上添加一个Router实例属性。
const router: Router = UserController["router"];取得router后,你便可以向往常一样使用koa-router的方式
app.use(router.routes());
// or
app.use(UserController["router"].routes());Doucuments
@Controller
对应koa-router的Router。
参数
| param | type | description | default |
|---|---|---|---|
| prefix | string | 该Router的前缀/根路径 | "" |
| config | object | 对应Router的opts | {} |
@Get、Post、Delete、Put
参数
| param | type | description | default |
|---|---|---|---|
| url | string | 路径表达式 | "/" |
后续更新
实现
koa-router的Named routes。实现
koa-router的Multiple middleware。添加
Typescript的声明文件。
要求
- 项目需是使用
Koa - 使用
koa-router