提供tms-koa框架的验证码功能。

tms-koa 验证码方法

设置验证服务

在账号服务模块配置文件.config/captcha.js中设置

export default {
  disabled: false, // boolean 是否启用验证码
  storageType: 'lowdb', // 验证码存储方式  lowdb | redis
  masterCaptcha: 'aabb', // string 万能验证码
  codeSize: 4, //验证码长度  默认4
  alphabetType: 'number,upperCase,lowerCase', // 字母表生产类型 默认 数字+大写字母+小写字母
  alphabet: '1234567890', // 与alphabetType不可公用，优先级大于alphabetType
  expire: 300, // 过期时间 s 默认300
}

| 字段 | 说明 | 类型 | 默认 | 必填 | | ------------- | ------------------------------------------------------------------ | ------- | -------------------------- | ---- | | disabled | 是否启用验证码 | boolean | false | 否 | | storageType | 验证码存储方式 支持 redis、lowdb | string | lowdb | 否 | | masterCaptcha | 万能验证码 | string | | 否 | | codeSize | 验证码长度 | int | 4 | 否 | | alphabetType | 验证码字母表类型 与 alphabetType 不可公用，优先级大于 alphabetType | string | number,upperCase,lowerCase | 否 | | expire | 验证码有效期（s） | int | 300 | 否 |

tms-koa 配置验证码服务

在tms-koa框架配置文件./config/app.js中配置

export default {
  auth: {
    captcha: {
      disabled: false,
      path: '', // 验证码生成方法文件位置
      checkPath: '', // 验证码检查方法位置
      code: '', // 固定的验证码（用于开发测试）
      npm: {
        disabled: false,
        id: 'tms-koa-captcha',
        module: 'dist',
        checker: 'checkCaptcha',
        generator: 'createCaptcha',
      },
    },
  },
}

| 字段 | 说明 | 类型 | 默认 | | ----------------------------- | ----------------------------------------- | ------ | ----- | | captcha.npm.disabled | 是否使用 | | false | | captcha.npm.id | 使用的 npm 包名称，例如：tms-koa-captcha | string | | | captcha.npm.module | npm 包中的模块，例如：dist | string | | | captcha.npm.checker | 验证码检查函数（……） | string | | | captcha.npm.generator | 验证码生成函数（……） | string | | | captcha.npm.node_modules_root | 指定 npm 包的位置（为了调试代码时方便。） | string | |

API 调用示例

获取验证码

curl 'http://localhost:3001/auth/captcha?appid=demo&captchaid=demo01'

curl 'http://localhost:3001/auth/captcha?appid=demo&captchaid=demo01&returnType=text'

附加参数

| 参数 | 说明 | 默认值 | | ------------ | ------------------------------------------------- | --------------------------- | | storageType | 验证码存储方式lowdb / redis | lowdb | | codeSize | 验证码长度 | 4 | | alphabetType | 字母表类型 默认 数字+大写字母+小写字母 | "number,upperCase,lowerCase | | alphabet | 与 alphabetType 不可公用，优先级大于 alphabetType | "1234567890" | | expire | 过期时间，单位秒 | 300 | | returnType | 返回验证码类型text / image | image |

检验验证码

curl 'http://localhost:3001/auth/checkCaptcha?appid=demo&captchaid=demo01&code='

附加参数

| 参数 | 说明 | 默认值 | | ---------- | ----------------- | ------ | | strictMode | 检验大小写N / Y | N |