api-usually v1.0.8

主要功能介绍

服务端业务常用模块

1. 服务端生成用户的token
2. 服务端解析token,得到userid
3. 保存图片
4. 参数检查

使用说明

安装

npm install api-usually

全局引用

const {api,token,ajv} = require('api-usually');

使用示例

validate

功能介绍:参数检查
参数介绍
schema:model中的属性定义
data:需要检查的数据
使用示例:
ajv.validate(
  {
    schema: {},
    data: {}
  }
)
返回值:
  成功时返回：{
    state:true
  }
  失败时返回：{state:false,errors:validate.errors}

saveImage

功能介绍:保存图片
参数介绍
  path:'xxxxxxxxxxxx'  //图片要保存至的目录
  filename:'xxxxxxxxxxxxxx' // 文件名
  使用示例:
  api.saveImage(
    {
      path:'/static/images/',
      filename:'aaa.jpg'
    }
  )
返回值:
  成功时返回:1
  失败时返回:0

getImages

功能介绍:获取图片列表
参数介绍
  path:'xxxxxxxxxxxxxxxxx'   //图片路径
使用示例：  
api.getImages(path)
返回值:
  成功时返回:图片列表（数组）
  失败时返回:null

create

功能介绍:生成用户token
参数介绍
userInfo:用户信息
使用示例:
token.create(
  {
    id:'xxxx',
    openid:'xxxxxxxxxxxx',
    sessionkey:'xxxxxxxxx'
  }
)
返回值:
  成功时返回:token字符串
  失败时返回:null

getUserId

功能介绍:通过token解析出userid
参数介绍:
token:前一个方法生成的token
使用示例:token.getUserId(token)
返回值:
  成功时返回:userid
  失败时返回:0