微信小程序常用api

21 阅读2分钟

微信小程序的API(Application Programming Interface,应用程序编程接口)是一系列用于开发微信小程序的接口和方法。通过这些API,开发者可以实现各种功能,包括用户登录、获取用户信息、发送消息、支付等等。本文将详细介绍微信小程序的API,帮助开发者更好地了解和使用它们。

一、用户登录相关API

  1. wx.login:用于获取用户登录凭证(code),开发者可以将code发送到服务器进行用户登录验证。

  2. wx.checkSession:用于检查用户登录态是否过期,如果过期则需要重新调用wx.login获取新的code。

  3. wx.getUserInfo:用于获取用户的基本信息,包括昵称、头像等。

二、界面相关API

  1. wx.showToast:用于显示消息提示框,可以设置显示的文字、图标和持续时间。

  2. wx.showModal:用于显示模态对话框,可以设置标题、内容和按钮。

  3. wx.showLoading:用于显示加载提示框,可以设置显示的文字和是否遮罩。

  4. wx.hideToast:用于隐藏消息提示框。

  5. wx.hideLoading:用于隐藏加载提示框。

三、网络请求相关API

  1. wx.request:用于发起网络请求,可以设置请求的URL、请求方法、请求头和请求数据等。

  2. wx.uploadFile:用于上传文件,可以设置上传的URL、文件路径和文件类型等。

  3. wx.downloadFile:用于下载文件,可以设置下载的URL和保存文件的路径等。

四、数据缓存相关API

  1. wx.setStorageSync:用于将数据存储到本地缓存中,可以设置数据的键值对。

  2. wx.getStorageSync:用于从本地缓存中获取数据,可以根据键值获取对应的数据。

  3. wx.removeStorageSync:用于从本地缓存中移除数据,可以根据键值移除对应的数据。

五、支付相关API

  1. wx.requestPayment:用于发起支付请求,可以设置支付的参数,如支付金额、商品描述等。

六、小程序跳转相关API

  1. wx.navigateTo:用于跳转到其他页面,可以传递参数给目标页面。

  2. wx.redirectTo:用于关闭当前页面并跳转到其他页面,可以传递参数给目标页面。

  3. wx.navigateBack:用于返回上一页,可以设置返回的页数。

七、小程序生命周期相关API

  1. onLoad:小程序初始化时触发的生命周期函数。

  2. onShow:小程序显示时触发的生命周期函数。

  3. onHide:小程序隐藏时触发的生命周期函数。

  4. onUnload:小程序关闭时触发的生命周期函数。