微图知行(vtuzx-web)开源包

基于vtuzx-core, express 提供restfulAPI服务框架

使用配置

基于vtuzx-core基础配置, 在conf内配置http模块

{
    http: {
        poweredBy: "设置api访问时response header内的x-powered-by, 空时不设置header, 可通过response进行覆盖, 默认值[vtuzx]",
        traceLevel: "设置访问日志级别, none, debug, info, 默认值[debug]",
        kind: "设置默认Action类型, json, form, redirect, download, 默认[json]",
        method: "设置默认Action访问, *, get, post, 默认[post]",
        needToken: "boolean, 设置默认needToken, 默认[false]",
        hideIndex: "boolean, 设置是否通过文件夹路径来访问index.js文件, 默认[true]",
        scan: "设置扫描Action的路径, 默认[/src/vtuzx/action]",
        scanRegex: "设置扫描规则, 默认[.*\\.js]",
        except: "设置文件名排除关键字, 默认[ ]",
        logLevelWhenStart: "设置Action启动时日志级别, 默认[info]",
        timeout: "设置Action默认超时时间, 默认[60000]",
        tempPath: "设置上传临时文件路径, 默认无",
        prefixPath: "设置Action访问路径前置path, 默认无"
    }
}

Action Class构造方法

可通过以下方式进行设置
vtuzxUtil.extend(profile, {
    kind: 'Action类型, 默认为系统配置的kind',
    method: '访问方法, 默认为系统配置的method',
    needToken: 'boolean, 是否需要Token, 默认为系统配置的needToken',
    path: 'API访问路径, 默认为文件路径',
    event: 'API名, 默认为文件名去除系统配置内的except',
    trace: '监控级别, 默认为系统配置的traceLevel',
    timeout: '数值, 超时时间, 默认为系统配置的timeout',
    disable: 'boolean 是否有效, 默认有效',
    rules: '数组, 参数校验规则'
    
})
参数校验规则
[
    {
        key: "name",                        // 参数关键字
        title: "姓名",                       // 姓名 
        must: true                          // 是否必须
        length: { min: 99, max: 99 }        // 长度限制
        range: { min: 99, max: 99 }         // 数值限制
        select: []                          // 选项值
        type: 参照constant.paramType         // 类型
    }
]