docs: 完善文档

This commit is contained in:
Fu Diwei
2021-06-07 00:32:04 +08:00
parent 2e294b0ce7
commit 8609f89c6d
15 changed files with 360 additions and 54 deletions

View File

@@ -2,16 +2,20 @@
---
本库封装了直接解析事件的扩展方法,下面给出一个示例:
你可根据官方文档的规则利用本库提供的 `WxBizMsgCryptor` 工具类自行解密回调通知事件的敏感信息。
对于解密后得到的原始数据,本库封装了直接解析成事件模型的扩展方法,下面给出一个示例:
```csharp
/* 如果是 JSON 格式的通知内容 */
string callbackJson = "...";
string callbackJson = "{ ... }";
var callbackModel = client.DeserializeEventFromJson<Events.WxaMediaCheckEvent>(callbackJson);
/* 如果是 XML 格式的通知内容 */
string callbackXml = "...";
string callbackXml = "<xml> ... </xml>";
var callbackModel = client.DeserializeEventFromXml<Events.TextMessageEvent>(callbackXml);
```
完整的回调通知模型定义可以参考项目目录下的 _src/SKIT.FlurlHttpClient.Wechat.Api/Events_ 目录。
需要注意的是,如果在微信公众平台后台配置中选择了明文模式,则无需对数据进行解密。

View File

@@ -6,7 +6,7 @@
>
> [《微信官方文档 - 微信网页开发JS-SDK 说明文档》](https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html)
你可根据官方文档的规则利用本库提供的 `Sha1Util` 工具类自行进行签名生成。
你可根据官方文档的规则利用本库提供的 `SHA1Utility` 工具类自行进行签名生成。
此外,本库还封装了直接生成参数及签名的扩展方法,下面给出一个示例:

View File

@@ -12,7 +12,7 @@
- 基于微信公众平台 & 开放平台 API 封装。
- 提供了微信公众平台 & 开放平台 API 所需的 SHA-1、HMAC-SHA-256 等算法工具类。
- 提供了微信公众平台 & 开放平台 API 所需的 SHA-1、HMAC-SHA-256、AES 等算法工具类。
- 提供了 JS-SDK 签名、解析回调通知事件等扩展方法。
@@ -144,7 +144,7 @@ var request = new CgibinUserInfoRequest()
AccessToken = "微信 AccessToken",
OpenId = "微信 OpenId"
};
var response = await TestClients.Instance.ExecuteCgibinUserInfoAsync(request);
var response = await client.ExecuteCgibinUserInfoAsync(request);
```
---