docs: 完善文档

This commit is contained in:
Fu Diwei
2021-07-27 00:50:51 +08:00
parent 3b9ee6067b
commit 1317ed6110
3 changed files with 37 additions and 9 deletions

View File

@@ -6,9 +6,13 @@
<summary>SKIT.FlurlHttpClient.Wechat 更新日志</summary>
- Release 1.0.2
- **新增**:新增 `IWechatClient.JsonSerializer` 属性。
- Release 1.0.1
- **变更**:移除 `IWechatClient.CreateRequest` 方法。
- **变更**:移除 `IWechatClient.CreateRequest()` 方法。
- Release 1.0.0
@@ -22,6 +26,12 @@
<summary>SKIT.FlurlHttpClient.Wechat.Api 更新日志</summary>
- Release 1.2.0
- **新增**:新增 `WechatApiClient.Credentials` 属性。
- **变更**:移除 `WechatApiClient.FlurlJsonSerializer` 属性。
- Release 1.1.0
- **新增**:新增小程序获取用户加密 Key 相关接口。
@@ -30,7 +40,7 @@
- Release 1.0.1
- **新增**:新增 `WechatApiClient.CreateRequest` 方法。
- **新增**:新增 `WechatApiClient.CreateRequest()` 方法。
- Release 1.0.0
@@ -44,6 +54,18 @@
<summary>SKIT.FlurlHttpClient.Wechat.TenpayV3 更新日志</summary>
- Release 1.4.0
- **新增**:新增批量获取分账账单相关接口。
- **新增**:随官方更新分账、服务商分账接口相关字段。
- **新增**:新增 `WechatTenpayV3Client.Credentials` 属性。
- **变更**:移除 `WechatTenpayV3Client.FlurlJsonSerializer` 属性。
- **变更**:移除 `ICertificateStorer` 接口,新增 `CertificateManager` 抽象类。
- Release 1.3.1
- **新增**:新增批量转账到零钱相关接口。
@@ -54,7 +76,7 @@
- Release 1.2.1
- **新增**:新增 `WechatTenpayV3Client.CreateRequest` 方法。
- **新增**:新增 `WechatTenpayV3Client.CreateRequest()` 方法。
- Release 1.2.0
@@ -82,6 +104,12 @@
<summary>SKIT.FlurlHttpClient.Wechat.Work 更新日志</summary>
- Release 1.2.0
- **新增**:新增 `WechatWorkClient.Credentials` 属性。
- **变更**:移除 `WechatWorkClient.FlurlJsonSerializer` 属性。
- Release 1.1.0
- **新增**:随官方更新客户联系接口相关字段。
@@ -90,7 +118,7 @@
- Release 1.0.1
- **新增**:新增 `WechatWorkClient.CreateRequest` 方法。
- **新增**:新增 `WechatWorkClient.CreateRequest()` 方法。
- **新增**:新增企业微信小程序相关接口。

View File

@@ -4,7 +4,7 @@
验证回调通知事件签名的方法与验证响应签名的类似,请参阅[相关文档](./Advanced_ResponseSignatureVerification.md)。
同样的,你既然可以利用本库提供的 `RSAUtility` 工具类自行进行签名验证,也可以通过 `ICertificateManager` 尝试自动完成签名验证:
同样的,你既然可以利用本库提供的 `RSAUtility` 工具类自行进行签名验证,也可以通过 `CertificateManager` 尝试自动完成签名验证:
```csharp
bool ret = client.VerifyEventSignature(

View File

@@ -43,9 +43,9 @@ bool ret = RSAUtility.VerifyWithSHA256(publicKey, data, sign);
---
#### 通过 `ICertificateManager` 接口存取平台证书信息:
#### 通过 `CertificateManager` 管理平台证书信息:
微信商户平台证书需要通过 API 的方式获取、且可能同时存在多个有效证书,本库提供了一个 `ICertificateManager` 接口可用于存取证书信息。
微信商户平台证书需要通过 API 的方式获取、且可能同时存在多个有效证书,本库提供了一个 `CertificateManager` 类型可用于管理证书信息。
你可以在构造得到 `WechatApiClient` 对象时指定证书管理器:
@@ -55,12 +55,12 @@ var options = new WechatTenpayClientOptions() { CertificateManager = certManager
var client = new WechatTenpayClient(options);
```
> 注:`InMemoryCertificateManager` 是本库内置的基于内存实现的证书管理器;你也可实现 `ICertificateManager` 接口,例如利用数据库或 Redis 等方式存取证书信息。
> 注:`InMemoryCertificateManager` 是本库内置的基于内存实现的证书管理器;你也可自行继承并实现一个 `CertificateManager`,例如利用数据库或 Redis 等方式存取证书信息。
你应在后台周期性地调用 `QueryCertificatesAsync()` 方法,并在解密得到证书内容后,记录到证书管理器中:
```csharp
certManager.Set("CER 证书序列号", "CER 证书内容");
certManager.SetCertificate("CER 证书序列号", "CER 证书内容");
```
每个响应对象会包含一个名为 `WechatpayCertSerialNumber` 的公共字段,本库会根据该字段的值自动尝试在证书管理器中读取证书内容,并完成响应签名的验证: