Skip to content

API 使用原则

小程序 API 覆盖网络、存储、设备、媒体、开放能力和基础组件。调用前确认权限、基础库兼容性、用户授权状态及失败路径;API 成功不等于业务成功。

常用能力

场景优先 API / 处理
网络wx.request;封装超时、状态码、业务码与登录失效
本地存储wx.setStorage / wx.getStorage;只存小型非敏感缓存
登录wx.login 换取临时 code,再由服务端换取业务会话
授权按需调用能力,必要时通过 wx.openSetting 引导用户
媒体选择、预览、上传分阶段处理并校验服务端结果
支付服务端生成支付参数,客户端 wx.requestPayment 发起支付

Promise 化

多数 API 可直接使用 Promise 风格;回调型 API 统一在基础设施层转换,页面只处理业务结果。

js
const { code } = await wx.login()
const result = await wx.request({ url: 'https://api.example.com/health' })

禁止事项

  • 不在客户端保存服务端密钥、支付签名密钥或可长期复用的高权限凭据。
  • 不信任客户端传入的用户身份、金额、订单状态和权限。
  • 不把授权失败、取消操作当作异常弹窗循环打扰用户。
  • 不为“预先收集”而申请隐私权限;在实际功能触发前说明用途。

基于 MIT 许可发布