docs: 完善文档

This commit is contained in:
Fu Diwei
2023-03-02 19:36:47 +08:00
parent f059387edc
commit 4a2ab538e9
55 changed files with 173 additions and 167 deletions

View File

@@ -9,6 +9,15 @@
同样地,你既可以利用本库提供的 `SHA1Utility` 工具类自行进行签名验证,也可以通过扩展方法实现:
```csharp
/* 在初始化客户端时需指定服务器推送的相关参数 */
var options = new WechatApiClientOptions()
{
// 其他配置项略
PushToken = "Token",
PushEncodingAESKey = "EncodingAESKey"
};
var client = new WechatApiClient(options);
/* 验证微信服务器 */
bool ret = client.VerifyEventSignatureForEcho(
callbackTimestamp: "微信回调通知中的 timestamp 字段",

View File

@@ -1,4 +1,4 @@
## 如何扩展额外的 API
## 如何自定义额外的 API 接口
---

View File

@@ -16,7 +16,7 @@
本库会定期随微信官方更新接口或模型,但也会偶有疏漏。如果你在使用中遇到了因接口或模型定义而产生的问题,欢迎提出 Issue。
如果你的项目来不及等待 Issue 被处理,你可以自行扩展相关 API。详细方式请参阅本文档[高级技巧 - 如何扩展额外的 API](./Advanced_Extensions.md)。
Issue 被处理之前,你可以选择自行扩展 API。详细方式请参阅本文档[基础用法 - 如何扩展额外的 API](./Basic_Extensions.md)。
---

View File

@@ -1,20 +1,18 @@
# SKIT.FlurlHttpClient.Wechat.Api
基于 `Flurl.Http` 的[微信公众平台](<(https://mp.weixin.qq.com/)>) & [微信开放平台](<(https://open.weixin.qq.com/)>) API 客户端
基于 `Flurl.Http` 的[微信公众平台](<(https://mp.weixin.qq.com/)>) & [微信开放平台](<(https://open.weixin.qq.com/)>) HTTP API SDK
---
## 功能
- 基于微信公众平台 & 微信开放平台 API 封装。
- 提供了微信公众平台 & 微信开放平台 API 所需的 SHA-1、HMAC-SHA-256、AES 等算法工具类。
- 提供了微信公众平台 & 微信开放平台 API 所需的 AES、SHA-1、HMAC-SHA-256 等算法工具类。
- 提供了 JS-SDK 签名、解析回调通知事件等扩展方法。
---
## 基础用法
## 快速入门
### 安装:
@@ -75,20 +73,24 @@ else
---
## 基础用法
- [如何快速找到需要调用的 API 模型类名 / 方法名?](./Basic_ModelDefinition.md)
- [如何解析回调通知事件?](./Basic_EventDeserialization.md)
- [如何验证回调通知事件签名?](./Basic_EventSignatureVerification.md)
- [如何解密经过加密处理的开放数据?](./Basic_OpenDataDecryption.md)
- [如何生成 JS-SDK 初始化时所需的参数及签名?](./Basic_Parameters.md)
- [如何自定义额外的 API 接口?](./Basic_Extensions.md)
---
## 高级技巧
- [如何快速找到需要调用的 API 模型类名 / 方法名?](./Advanced_ModelDefinition.md)
- [如何解析回调通知事件?](./Advanced_EventDataDeserialization.md)
- [如何验证回调通知事件签名?](./Advanced_EventDataSignatureVerification.md)
- [如何解密经过加密处理的开放数据?](./Advanced_OpenDataDecryption.md)
- [如何生成 JS-SDK 初始化时所需的参数及签名?](./Advanced_Parameters.md)
- [如何扩展额外的 API](./Advanced_Extensions.md)
- [如何在 ASP.NET Core 中与 `IHttpClientFactory` 集成?](./Advanced_IHttpClientFactory.md)
- [如何指定 JSON 序列化器?](./Advanced_JsonSerializer.md)