souljs
A nodejs web framework, 对koa简单包装,装饰风格,内置开发常用中间件,使用typescript编写
快速开始
git clone https://github.com/test/souljs-starter.gitnpm install && npm run start
Node.js >= 8.0.0 required.
创建应用实例
;; main;
路由处理并返回数据
通过@Render返回视图
请求参数验证
接口描述
接口文档默认访问地址: /swagger-ui/index.html
计划任务 @CronJob
使用修饰器@CronJob执行计划任务
API
createApplication(root, controllers, options): Application
-
参数
- { string } root - 项目路径
- { string | controller[] } controllers - 控制器的目录位置,使用globs匹配,或者是控制器类的数组
- { ApplicationOptions } options - 参考如下ApplicationOptions, 值false不启用功能
-
返回值:Application
Application
实例方法
-
use(mid: Koa.Middleware)
-
listen(port: number)
-
getKoaInstance(): Koa
-
getHttpServer(): http.Server
http请求装饰器
内部使用koa-router中间件,提供对应的方法的装饰器
-
@Controller(string|void)
-
@POST(string|void)
-
@Get(string|void)
@Render(view: string) 模板渲染
Joi验证请求参数
使用-
BodySchame(schame: joi.AnySchema)
-
QuerySchame(schame: joi.AnySchema)
控制器处理方法参数注入
test@Body Body: any, @Query query: any
自定义装饰器
; // 使用装饰器
提供如下修饰器
-
@Ctx() - ctx
-
@Request() - ctx.request
-
@Response() - ctx.Response
-
@Query(string|void) - ctx.request.query[string] | ctx.request.query
-
@Body(string|void) - ctx.request.body[string] | ctx.request.body
-
@ApplicationInstance() - 当前应用实例
-
@KoaInstance() - 当前koa实例