docs: 完善文档

This commit is contained in:
Fu Diwei 2021-07-31 23:08:11 +08:00
parent 05a276dfe1
commit cc08f4d6fd
4 changed files with 51 additions and 8 deletions

View File

@ -35,12 +35,12 @@
## 模块
| 名称 | NuGet | 其他 |
| :---------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------: |
| 公众平台(公众号、小程序) & 开放平台模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.Api.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Api) | [开发文档](./docs/WechatApi/README.md)[示例项目](./docs/WechatApi/Sample.md) |
| 商户平台(微信支付)模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.TenpayV3.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.TenpayV3) | [开发文档](./docs/WechatTenpayV3/README.md) |
| 企业微信(企业号)模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.Work.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Work) | [开发文档](./docs/WechatWork/README.md) |
| 广告平台(广点通)模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.Ads.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Ads) | [开发文档](./docs/WechatAds/README.md) |
| 名称 | NuGet | 其他 |
| :---------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :--------------------------------------------------------------------------------------: |
| 公众平台(公众号、小程序) & 开放平台模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.Api.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Api) | [开发文档](./docs/WechatApi/README.md)[示例项目](./docs/WechatApi/Sample.md) |
| 商户平台(微信支付)模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.TenpayV3.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.TenpayV3) | [开发文档](./docs/WechatTenpayV3/README.md)[示例项目](./docs/WechatTenpayV3/Sample.md) |
| 企业微信(企业号)模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.Work.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Work) | [开发文档](./docs/WechatWork/README.md) |
| 广告平台(广点通)模块 | [![NuGet Version](https://img.shields.io/nuget/v/SKIT.FlurlHttpClient.Wechat.Ads.svg?sanitize=true)](https://www.nuget.org/packages/SKIT.FlurlHttpClient.Wechat.Ads) | [开发文档](./docs/WechatAds/README.md) |
---

View File

@ -12,7 +12,9 @@
示例项目实现了以下功能:
- 多租户 AccessToken 中控;
- 多租户微信账号;
- AccessToken 中控;
- 验证并接收微信服务器推送数据;
@ -58,4 +60,4 @@
#### 4. 安全性:
示例项目中不包含授权认证等相关的业务逻辑,开发者可根据业务需要自行实现。
示例项目中不包含授权认证等相关的业务逻辑,开发者可根据业务需要自行实现。

View File

@ -151,3 +151,11 @@ else
- [如何生成客户端调起支付时所需的参数及签名?](./Advanced_Payment.md)
- [如何扩展额外的 API](./Advanced_Extensions.md)
---
## 示例项目
为方便开发者快速掌握本库的使用方法,这里提供一个示例项目以供参考。
请阅读[《示例项目说明》](./Sample.md)。

View File

@ -0,0 +1,33 @@
## 示例项目
---
示例项目位于 _samples/SKIT.FlurlHttpClient.Wechat.TenpayV3.Sample_Net5_。
示例项目基于 .NET 5.0 实现。
示例项目实现了以下功能:
- 多租户商户号;
- 微信商户平台证书自动更新。
- 验证并接收微信服务器推送数据;
- 一个 JSAPI 下单和退款的 API。
---
### 【重要】使用须知:
示例项目仅作为业务上的参考,不代表可直接用于生产。
开发者应提前知晓:
#### 1. 容错性:
示例项目中未特殊处理可能产生的异常(如:空指针等),开发者可根据业务需要自行实现。
#### 2. 安全性:
示例项目中不包含授权认证等相关的业务逻辑,开发者可根据业务需要自行实现。