您当前的位置: 首页 > 知识百科 > 如何开发小程序api操作方法

如何开发小程序api操作方法

时间:2023-07-01 14:05 阅读数:77 人阅读 分类:知识百科

  最近有很多人问小编如何开发小程序api,关于小程序api,其实小编之前也在微信小程序商店讲过不少资料,细心的朋友一定能够触类旁通知道怎么开发api。当然,如果还有不懂的,那就再看一看以下资料吧。

  我们先了解微信小程序API的结构:

  了解了文档结构后,我们就可以开始进行小程序api的开发了。

  OBJECT参数说明:

  参数类型必填说明

  urlString是开发者服务器url

  filePathString是要上传文件资源的路径

  nameString是文件对应的key , 开发者在服务器端通过这个key可以获取到文件二进制内容

  headerObject否HTTP 请求 Header,header中不能设置Referer

  formDataObject否HTTP 请求中其他额外的form data

  successFunction否小程序接口调用成功的回调函数

  failFunction否接口调用失败的回调函数

  completeFunction否接口调用结束的回调函数(调用成功、失败都会执行)

  success返回参数说明:

  参数类型说明

  dataString开发者服务器返回的数据

  statusCodeNumberHTTP状态码

  示例代码:

  wx.chooseImage({

  success:function(res){

  var tempFilePaths = res.tempFilePaths

  wx.uploadFile({

  url: 'example.weixin.qq/upload', //仅为示例,非真实的接口地址

  filePath: tempFilePaths[0],

  name:"file",

  formData:{

  "user":"test"

  } success: function(res){ var data = res.data //do something }

  })

  }

  })

  返回值:

  基础库 1.4.0 开始支持,低版本需做兼容处理

  返回一个uploadTask对象,通过uploadTask,可监听上传进度变化事件,以及取消上传任务。

  uploadTask

  uploadTask 对象的方法列表:

  方法参数说明最低版本

  onProgressUpdatecallback小程序监听上传进度变化1.4.0

  abort 中断上传任务1.4.0

  onProgressUpdate 返回参数说明:

  参数类型说明

  progressNumber上传进度百分比

  totalBytesSentNumber已经上传的数据长度,单位 Bytes

  totalBytesExpectedToSendNumber预期需要上传的数据总长度,单位 Bytes

  示例代码:

  const uploadTask = wx.uploadFile({

  url: 'example.weixin.qq/upload', //仅为示例,非真实的接口地址

  filePath: tempFilePaths[0],

  name: 'file',

  formData:{

  'user': 'test'

  },

  success: function(res){

  var data = res.data

  //do something

  }

  })

  uploadTask.onProgressUpdate((res) => {

  console.log('上传进度', res.progress)

  console.log('已经上传的数据长度', res.totalBytesSent)

  console.log('预期需要上传的数据总长度', res.totalBytesExpectedToSend)

  })

  uploadTask.abort() // 取消上传任务

  大家看完以上资料之后,对于如何开发小程序api都了如指掌了吧?不得不承认小程序api的用处还是很大的,既能发起小程序请求,还能实现上传下载、小程序录音等功能,所以大家赶紧开发起来吧。

  

  微信小程序api封装怎么操作

  小程序api手册有什么作用?

  微信小程序API音频播放控制