Skip to content

ChYuanJinlin/wx-simplifyData

Repository files navigation

安装

npm i wx-simplify-data -S

使用

在wx app.js 文件引入

import simplify from 'wx-simplify-Data'
<!-- 初始化 -->
simplify.init({
  <!-- 需要传一个api对象过来 -->
  api:传入你的api 对象
})

<!--
初始化配置之后,将会在微信对象上挂在一个叫wx.$getData()函数和wx.$am,你就可以使用这个函数来简易操作请求api接口,
 用法:wx.$getData(wx.$am.你定义api函数名或者直接传你定义api的字符串函数名过来,{},fn)
    -->

simplify.init(optios:Object)(全局配置)

属性 类型 默认值 必填 说明
api object 定义的api对象
statusCode number 200 接口返回字段的成功失败的状态
log boolean true 日志信息
msgField string msg 接口返回提升消息字段
statusCodeText string status 接口返回成功失败的字段
dataFilels string data 接口返回数据的字
toast object|boolean false 配置微信提示,用法和微信wx.showToast一样,为true 根据接返回的消息字段默认提示

wx.$getData(methodName:string,optios:Object | fn[, fn])

属性 类型 默认值 必填 说明
methodName string 导出api 对象定义的函数名
optios object null 配置参数如下
fn function setData赋值之前的回调,用作于改变接口数据里面的结构,或者增加字段,格式化时间操作
属性 类型 默认值 必填 说明
params object 需要向接口传过去的数据
setData string|function 指定你需要赋值的属性字段
dataField string data 接口返回数据的字段
statusCodeText string status 接口返回是否成功状态字段
statusCode number|string 200 接口返回是否成功状态value
msgField string msg 接口返回提示消息字段
isPage boolean false 是否是分页接口,注意事项:如果是分页接口需要在wx上 新增一个 data:{pages:{page:1}}
pageAttr string page 分页类型的接口需要传一个你当前第几页的字段过来,不传取默认值
success function 成功自定义回调
toast object|boolean 配置微信提示,如果传true默认采用,用法和微信wx.showToast一样,不传不会显示,全局配置了,将会采用全局配置
completeTip function|object 数据请求完成的提示回调,不传将会默认提示
loadMore function 当上拉加载更多赋值不满足时,需要使用这个函数来自定义上拉加载更多
noData function|object 当是分页接口时候,加载更多之后没有数据的时候提示回调,如果传对象和wx.showToast 用法一样
failTip function|object 不是成功状态码的提示回调,不传将会默认提示
custom function 得到数据之后的回调,调用该函数之后只需要自己自定义

版本更新

v1.0.23

  1. apiData修改为params
  2. type修改为isPage
  3. 新增pageAttr字段
  4. 去掉showLoadingText字段
  5. 去掉name字段

版本历史

v1.0.1 v1.0.21 v1.0.22

About

小程序简易获取api 数据

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published