https://github.com/upyun/wechat-sdk

又拍云微信小程序 SDK
https://github.com/upyun/wechat-sdk

Last synced: 3 months ago
JSON representation

又拍云微信小程序 SDK

• Host: GitHub
• URL: https://github.com/upyun/wechat-sdk
• Owner: upyun
• Created: 2017-02-21T08:28:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-11-20T17:53:20.000Z (almost 4 years ago)
• Last Synced: 2024-04-18T22:25:28.361Z (7 months ago)
• Language: JavaScript
• Size: 58.6 KB
• Stars: 69
• Watchers: 7
• Forks: 27
• Open Issues: 3
• Metadata Files:
  • Readme: Readme.md

Awesome Lists containing this project

• awesome-github-wechat-app - upyun-wxapp-sdk - 又拍云微信小程序 (实用库)

README

        
# 又拍云微信小程序 SDK

[又拍云](https://upyun.com) [微信小程序 SDK](http://docs.upyun.com/api/small_program/)，帮助你在存储空间、资源存放、访问加速、资源处理等方面进行大幅优化，为微信小程序提供扩容、加速解决方案。

## 使用

使用方式可以参考 demo

1. 登录微信小程序账户并配置 uploadFile 合法域名为 https://v0.api.upyun.com

2. 软链 upyun-wxapp-sdk.js 到微信小程序项目

3. 通过 `require` 引入 `Upyun` 类，并初始化一个实例

4. 调用 `upyun.upload` 方法上传文件

## 运行 Demo

下载微信[小程序开发工具](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/devtools.html)

增加 demo 目录为新项目

![add-project](assets/add-project.png)

运行服务器进程

    npm run demo

## 接口

`Upyun`

* bucket: 空间名

* operator: 操作员

* getSignatureUrl: 计算 `signature` 的服务器接口地址

示例

```js

const upyun = new Upyun({

  bucket: 'sdkimg',

  operator: 'tester',

  getSignatureUrl: 'http://localhost:8080',

})

```

`Upyun.prototype.upload`

* remotePath 在又拍云存储的文件路径

* localPath 本地文件路径

* success 接口调用成功的回调函数

* fail 接口调用失败的回调函数

* complete 接口调用结束的回调函数（调用成功、失败都会执行）

```js

upyun.upload({

  localPath: imageSrc,

  remotePath: '/wxapp/demo',

  success: function(res) {

  },

  fail: function({errMsg}) {

  },

})

```

## 服务器接口

使用又拍云微信小程序 SDK 需要实现一个在服务器进行签名的接口，并将该接口地址作为 `getSignatureUrl` 传入构造函数，

该接口接受 `GET` 请求，并接受一个参数 `data`，计算并返回带有 `signature` 字段的响应

`signature` 的计算公式是

    Base64 (HMAC-SHA1 (, )

其中，`md5_password` 是操作员密码的 MD5 值

## 相关链接

* [微信小程序 uploadFile 接口](https://mp.weixin.qq.com/debug/wxadoc/dev/api/network-file.html#wxuploadfileobject)

* [又拍云表单 API](https://docs.upyun.com/api/form_api/)

* [又拍云表单提交签名算法](http://docs.upyun.com/api/authorization/#body)