Skip to content

Commit

Permalink
docs: 完善文档
Browse files Browse the repository at this point in the history
  • Loading branch information
fudiwei committed Feb 15, 2024
1 parent ff6b7f6 commit 4930bca
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 3 deletions.
27 changes: 26 additions & 1 deletion docs/WechatApi/Migration_V3.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,22 @@ request.WithTimeout(TimeSpan.FromMinutes(2));
```csharp
/* v2.x 读取单个响应原始状态码 */
int statusCode = response.RawStatus;
/* v2.x 读取单个响应原始响应标头 */
IDictionary<string, string> headers = response.RawHeaders;
/* v2.x 读取单个响应原始响应体 */
byte[] bytes = response.RawBytes;

/* v3.x 读取单个响应原始状态码 */
int statusCode = response.GetRawStatus();
/* v3.x 读取单个响应原始响应标头 */
HttpHeaderCollection headers = response.GetRawHeaders();
/* v3.x 读取单个响应原始响应体 */
byte[] bytes = response.GetRawBytes();
```

### 新的构造器模式(设置 `HttpClient`
需要注意的是,上述 Get 方法返回的均为同一个对象引用,因此请不要在获取后尝试修改它们的内容。

### 新的构造器模式(配置 `HttpClient`

随着 `Flurl.Http` 的升级,原有的与 `IHttpClientFactory` 集成的方式发生了根本性的改变。

Expand All @@ -56,6 +66,21 @@ var options = new WechatApiClientOptions() { /* 具体配置项略 */ };
var client = new WechatApiClient(options);
```

### 新的异常类型

公共组件中提供了如下的异常类型:

- `CommonException`:异常基类。
- `CommonHttpException`:执行 HTTP 请求时引发的异常。
- `CommonTimeoutException`:超时引发的异常。
- `CommonSerializationException`:序列化或反序列化时引发的异常。
- `CommonInterceptorCallException`:拦截器引发的异常。

模块内更加细化的异常信息,统一由 `WechatApiException` 异常类型包装,但废弃并移除了其派生的异常类型:

- `WechatApiRequestTimeoutException`
- `WechatApiEventSerializationException`

### 基础类型:`SKIT.FlurlHttpClient.Primitives.EncodedeString`

在进行加解密或哈希等操作时,参与运算的数据和最终得到的结果通常是字节数组(即 `byte[]`)形式。而在实际应用中,我们常常需要将这些字节序列转换成文本格式。我们发现即便是同一种加解密或哈希算法,在不同平台上所需要的编码方式也可能不同。比如同为 SHA256,在某些接口中需要转换为十六进制(HEX)编码传参,而在另一些接口中却需要转换为 Base64 编码传参。
Expand Down
32 changes: 31 additions & 1 deletion docs/WechatTenpayV3/Migration_V3.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,22 @@ request.WithTimeout(TimeSpan.FromMinutes(2));
```csharp
/* v2.x 读取单个响应原始状态码 */
int statusCode = response.RawStatus;
/* v2.x 读取单个响应原始响应标头 */
IDictionary<string, string> headers = response.RawHeaders;
/* v2.x 读取单个响应原始响应体 */
byte[] bytes = response.RawBytes;

/* v3.x 读取单个响应原始状态码 */
int statusCode = response.GetRawStatus();
/* v3.x 读取单个响应原始响应标头 */
HttpHeaderCollection headers = response.GetRawHeaders();
/* v3.x 读取单个响应原始响应体 */
byte[] bytes = response.GetRawBytes();
```

### 新的构造器模式(设置 `HttpClient`
需要注意的是,上述 Get 方法返回的均为同一个对象引用,因此请不要在获取后尝试修改它们的内容。

### 新的构造器模式(配置 `HttpClient`

随着 `Flurl.Http` 的升级,原有的与 `IHttpClientFactory` 集成的方式发生了根本性的改变。

Expand All @@ -56,6 +66,26 @@ var options = new WechatTenpayClientOptions() { /* 具体配置项略 */ };
var client = new WechatTenpayClient(options);
```

### 新的异常类型

公共组件中提供了如下的异常类型:

- `CommonException`:异常基类。
- `CommonHttpException`:执行 HTTP 请求时引发的异常。
- `CommonTimeoutException`:超时引发的异常。
- `CommonSerializationException`:序列化或反序列化时引发的异常。
- `CommonInterceptorCallException`:拦截器引发的异常。

模块内更加细化的异常信息,统一由 `WechatTenpayException` 异常类型包装,但废弃并移除了其派生的异常类型:

- `WechatTenpayRequestTimeoutException`
- `WechatTenpayRequestEncryptionException`
- `WechatTenpayRequestSignatureException`
- `WechatTenpayResponseDecryptionException`
- `WechatTenpayResponseVerificationException`
- `WechatTenpayEventDecryptionException`
- `WechatTenpayEventVerificationException`

### 基础类型:`SKIT.FlurlHttpClient.Primitives.EncodedeString`

在进行加解密或哈希等操作时,参与运算的数据和最终得到的结果通常是字节数组(即 `byte[]`)形式。而在实际应用中,我们常常需要将这些字节序列转换成文本格式。我们发现即便是同一种加解密或哈希算法,在不同平台上所需要的编码方式也可能不同。比如同为 SHA256,在某些接口中需要转换为十六进制(HEX)编码传参,而在另一些接口中却需要转换为 Base64 编码传参。
Expand Down
27 changes: 26 additions & 1 deletion docs/WechatWork/Migration_V3.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,22 @@ request.WithTimeout(TimeSpan.FromMinutes(2));
```csharp
/* v2.x 读取单个响应原始状态码 */
int statusCode = response.RawStatus;
/* v2.x 读取单个响应原始响应标头 */
IDictionary<string, string> headers = response.RawHeaders;
/* v2.x 读取单个响应原始响应体 */
byte[] bytes = response.RawBytes;

/* v3.x 读取单个响应原始状态码 */
int statusCode = response.GetRawStatus();
/* v3.x 读取单个响应原始响应标头 */
HttpHeaderCollection headers = response.GetRawHeaders();
/* v3.x 读取单个响应原始响应体 */
byte[] bytes = response.GetRawBytes();
```

### 新的构造器模式(设置 `HttpClient`
需要注意的是,上述 Get 方法返回的均为同一个对象引用,因此请不要在获取后尝试修改它们的内容。

### 新的构造器模式(配置 `HttpClient`

随着 `Flurl.Http` 的升级,原有的与 `IHttpClientFactory` 集成的方式发生了根本性的改变。

Expand All @@ -56,6 +66,21 @@ var options = new WechatWorkClientOptions() { /* 具体配置项略 */ };
var client = new WechatWorkClient(options);
```

### 新的异常类型

公共组件中提供了如下的异常类型:

- `CommonException`:异常基类。
- `CommonHttpException`:执行 HTTP 请求时引发的异常。
- `CommonTimeoutException`:超时引发的异常。
- `CommonSerializationException`:序列化或反序列化时引发的异常。
- `CommonInterceptorCallException`:拦截器引发的异常。

模块内更加细化的异常信息,统一由 `WechatWorkException` 异常类型包装,但废弃并移除了其派生的异常类型:

- `WechatWorkRequestTimeoutException`
- `WechatWorkEventSerializationException`

### 基础类型:`SKIT.FlurlHttpClient.Primitives.EncodedeString`

在进行加解密或哈希等操作时,参与运算的数据和最终得到的结果通常是字节数组(即 `byte[]`)形式。而在实际应用中,我们常常需要将这些字节序列转换成文本格式。我们发现即便是同一种加解密或哈希算法,在不同平台上所需要的编码方式也可能不同。比如同为 SHA256,在某些接口中需要转换为十六进制(HEX)编码传参,而在另一些接口中却需要转换为 Base64 编码传参。
Expand Down

0 comments on commit 4930bca

Please sign in to comment.