Skip to content

SalakJS/salak-core

Repository files navigation

salak-core

NPM version build status David deps NPM download

Deprecated,move to salak

salak核心库,基于koa 2.0

不建议直接使用salak-core,可以直接使用 salak

特性

  • 自动路由,根据controller生成service
  • 中间件扩展,可以自定义中间件执行顺序
  • Joi校验,增强代码健壮性,提供路由执行前参数校验以及输出校验
  • 日志插件,基于winston

用法

目录结构

├── common
│   ├── config
│   │   └── default.js
│   └── middleware
│       └── error.js
├── blog
│   ├── config
│   │   └── default.js
│   ├── controller
│   │   ├── comment.js
│   │   └── post.js
│   ├── middleware
│   │   ├── auth.js
│   │   └── err.js
│   └── service
│       └── post.js
└── index.js

安装

npm install --save salak-core

编写controller

const { Controller } = require('salak-core')

class Post extends Controller {
  actionIndex () {
    this.ctx.body = 'hello, Post.'
  }
}

默认会注册/post 路由

API

SalakCore

constructor (options)

  • {Object} options - 配置
  • {String} options.baseDir - 项目根目录
  • {Object} options.opts - 其他设置
  • {String} options.opts.root - common目录命名,默认为common

router

salak-router 实例

loader

SalakCoreLoader 实例

License

MIT

About

A core framework base on koa.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published