koa-dir-router

一个 koa 的中间件，支持以文件夹目录为网址的访问形式，且不用重启 koa 服务，即可热更新文件夹内部的文件代码，修改即上线。在开发接口时方便修改代码，和无感上线。

可以使用其他中间件或者自己定义页面混用，koa-dir-router 只有在ctx.response.status === 404时候起作用

Installation

$ npm install koa-dir-router

Options

dir 一个储存代码的文件目录的绝对路径，必须传递 [String]
prefixUrl 请求路径的前缀,用来匹配本地文件默认是’/’ [String]
checkTimes 检测文件改动的时间，单位是 ms；默认是 1000 [Number]
errorLog 文件目录下的文件代码执行异常时的捕获的代码方法；接受到值是[Function]({path,des,error})
page404 文件目录下的文件代码不存在时，回调的函数接受到值是[Function](ctx)
debug 是否显示调试信息；默认是 true 接受到值是[Boolean]
context 执行业务函数时的上下文；默认是 global 接受到值是[Object]，方便把一些常用的方法放在上下文里，避免再次引入；
acceptMethods [String]参数，支持设定接受的方法默认是 ‘*’ ，规范是 ‘get,post’(1.1.6+)
httpMethod [Array]参数，支持扩展检测支持的方法默认是[get,post,put,delete](1.1.6+)

1.0.7 版本废除baseUrl 参数名，使用prefixUrl来替代；

Example

·
├──index.js
├──controller
   ├──mis
      ├──type.js

// ./controller/mis/type.js 推荐接口写法一个文件一个接口；
module.exports = function (ctx) {
  ctx.body = `show-ok`
}
// ./index.js
const dirRouter = require('koa-dir-router')
const Koa = require('koa')
const path = require('path')
var app = new Koa()

app.use(
  dirRouter({
    dir: path.join(__dirname, './controller'), // 传入要访问的目录机构
  })
)
app.listen(3000)

访问 http://localhost:3000/mis/type 时会对应到对应的文件目录下的 ./controller/mis/type.js这个文件代码

$ GET /mis/type

show-ok

如果需要一个基础的地址 prefixUrl

// ./index.js
const dirRouter = require('koa-dir-router')
const Koa = require('koa')
const path = require('path')
var app = new Koa()

app.use(
  dirRouter({
    dir: path.join(__dirname, './controller'), // 传入要访问的目录机构
    prefixUrl: '/mis', // 基础地址
  })
)
app.listen(3000)

访问 http://localhost:3000/mis/mis/type 时会对应到对应的文件目录下的 ./controller/mis/type.js

yields:

$ GET /mis/mis/type

show-ok

代码出问题时？

如果在开发时代码出问题了，koa-dir-router会有一个友好的提示

若是线上代码，可以使用errorLog来获取。

设置指定的传输方式(1.1.6+)

通过设置参数acceptMethods来指定程序来在特定的传输方式下起作用

针对不同的请求方法指定不同的执行方法体(1.1.6+)

在代码文件里可以使用一下 ctx.dirRouter.MethodsName方法来指定不同方式运行不用的代码体 MethodsName 可取值的范围是这个文件代码httpMethod，前提是和acceptMethods 允许该方式进入主程序；

这样就方便开发者可以快速分方式去处理程序

module.exports = async function (ctx) {
  await ctx.dirRouter.get((c) => {
    // 只会在get方式里执行
    console.log('执行了Get')
  })
  await ctx.dirRouter.post((c) => {
    // 只会在post方式里执行
    console.log('执行了POST')
  })
}

License

MIT