Skip to content

Commit 91717d9

Browse files
afkTafkT
committed
docs: 更新部分版本信息、忽略配置
1 parent e554969 commit 91717d9

File tree

7 files changed

+162
-64
lines changed

7 files changed

+162
-64
lines changed

‎API/README_API.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ implementation 'io.github.afkt:DevJava:1.5.3'
238238
[DevHttpCapture API]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/README.md
239239
[DevHttpCapture ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/CHANGELOG.md
240240
[DevEnvironment API]: https://github.com/afkT/DevUtils/blob/master/lib/Environment
241-
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/DevEnvironment/CHANGELOG.md
241+
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/CHANGELOG.md
242242
[DevDeprecated API]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/README.md
243243
[DevDeprecated ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/CHANGELOG.md
244244
[DevJava API]: https://github.com/afkT/DevUtils/blob/master/lib/DevJava/README.md

‎API/README_PROJECT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ implementation 'io.github.afkt:DevJava:1.5.3'
238238
[DevHttpCapture API]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/README.md
239239
[DevHttpCapture ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/CHANGELOG.md
240240
[DevEnvironment API]: https://github.com/afkT/DevUtils/blob/master/lib/Environment
241-
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/DevEnvironment/CHANGELOG.md
241+
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/CHANGELOG.md
242242
[DevDeprecated API]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/README.md
243243
[DevDeprecated ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/CHANGELOG.md
244244
[DevJava API]: https://github.com/afkT/DevUtils/blob/master/lib/DevJava/README.md

‎API/lib/HttpCapture/README.md‎

Lines changed: 76 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,44 @@
11

2-
## Gradle
2+
## DevHttpCapture
33

4-
```gradle
5-
// DevHttpCapture - OkHttp 抓包工具库
6-
implementation 'io.github.afkt:DevHttpCapture:1.1.9'
7-
```
4+
* 该库主要对使用 OkHttp 网络请求库的项目，提供 Http 抓包功能，并支持抓包数据加密存储。
85

9-
## 目录结构
6+
* **并且是以 Module ( ModuleName Key ) 为基础，支持组件化不同 Module 各自的抓包功能**，支持实时开关抓包功能、可控 Http 拦截过滤器。
107

11-
```
12-
- dev | 根目录
13-
- capture | Http 抓包实现代码
14-
```
8+
* 内置两个 Http 抓包拦截器，CallbackInterceptor ( 无存储逻辑，进行回调通知 )、HttpCaptureInterceptor ( 存在存储抓包数据逻辑 )
9+
10+
* `DevHttpCaptureCompiler` 提供对 `DevHttpCapture` 抓包库可视化功能
11+
12+
13+
### 最新版本
14+
15+
module | DevHttpCapture | DevHttpCaptureCompiler | DevHttpCaptureCompilerRelease
16+
:---:|:---:|:---:|:---:
17+
version | [![][maven_svg]][maven] | [![][maven_svg]][maven] | [![][maven_svg]][maven]
18+
19+
20+
### Gradle
1521

22+
```groovy
23+
dependencies {
24+
// DevHttpCapture - OkHttp 抓包工具库
25+
implementation 'io.github.afkt:DevHttpCapture:1.1.7'
1626
17-
## 框架功能介绍
27+
// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
28+
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:1.1.7'
29+
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:1.1.7'
30+
}
31+
```
1832

19-
> 该库主要对使用 OkHttp 网络请求库的项目，提供 Http 抓包功能，并支持抓包数据加密存储。
20-
>
21-
> **并且是以 Module ( ModuleName Key ) 为基础，支持组件化不同 Module 各自的抓包功能**，支持实时开关抓包功能、可控 Http 拦截过滤器。
22-
>
23-
> 内置两个 Http 抓包拦截器，CallbackInterceptor ( 无存储逻辑，进行回调通知 )、HttpCaptureInterceptor ( 存在存储抓包数据逻辑 )
2433

2534
### 使用示例
2635

2736
```kotlin
37+
38+
// ==================
39+
// = DevHttpCapture =
40+
// ==================
41+
2842
// 添加 Http 抓包拦截处理
2943
DevHttpCapture.addInterceptor(
3044
OkHttpClient.Builder, moduleName
@@ -35,25 +49,29 @@ DevHttpCapture.removeInterceptor(moduleName)
3549

3650
// 更新对应 Module Http 抓包拦截处理
3751
DevHttpCapture.updateInterceptor(moduleName, capture)
38-
```
39-
40-
## 事项
4152

42-
- 部分 API 更新不及时或有遗漏等，`具体以对应的工具类为准`
53+
// ===================================
54+
// = DevHttpCaptureCompiler 抓包可视化 =
55+
// ===================================
4356

44-
- [检测代码规范、注释内容排版，API 文档生成](https://github.com/afkT/JavaDoc)
4557

46-
- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/CHANGELOG.md)
58+
// 显示所有 Module 抓包数据
59+
DevHttpCaptureCompiler.start(context)
60+
// 显示指定 Module 抓包数据
61+
DevHttpCaptureCompiler.start(context, moduleName)
4762

48-
## API
49-
50-
51-
- dev | 根目录
52-
- [capture](#devcapture) | Http 抓包实现代码
63+
// =======
64+
// = 可选 =
65+
// =======
5366

67+
// 添加接口所属功能注释
68+
DevHttpCaptureCompiler.putUrlFunction(moduleName, UrlFunctionGet)
69+
// 移除接口所属功能注释
70+
DevHttpCaptureCompiler.removeUrlFunction(moduleName)
71+
```
5472

55-
## <span id="dev">**`dev`**</span>
5673

74+
## DevHttpCapture API
5775

5876
* **OkHttp 抓包工具库 ->** [DevHttpCapture.kt](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/DevHttpCapture/src/main/java/dev/DevHttpCapture.kt)
5977

@@ -161,4 +179,33 @@ DevHttpCapture.updateInterceptor(moduleName, capture)
161179
| callResponseBodyFailed | 生成错误响应体信息 |
162180
| callResponseBody | 生成响应体信息 Map |
163181
| converterRequestBody | 转换请求体信息 Map |
164-
| callEnd | 抓包结束 |
182+
| callEnd | 抓包结束 |
183+
184+
185+
## ## DevHttpCaptureCompiler API
186+
187+
* **OkHttp 抓包工具库 ->** [DevHttpCaptureCompiler.kt](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/DevHttpCaptureCompiler/src/main/java/dev/DevHttpCaptureCompiler.kt)
188+
189+
| 方法 | 注释 |
190+
| :- | :- |
191+
| finishAllActivity | 结束所有 Activity |
192+
| start | 跳转抓包数据可视化 Activity |
193+
| putUrlFunction | 添加接口所属功能注释 |
194+
| removeUrlFunction | 移除接口所属功能注释 |
195+
196+
197+
## <span id="devcapture">**`dev.capture`**</span>
198+
199+
200+
* **接口所属功能注释获取 ->** [UrlFunctionGet.kt](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/DevHttpCaptureCompiler/src/main/java/dev/capture/UrlFunctionGet.kt)
201+
202+
| 方法 | 注释 |
203+
| :- | :- |
204+
| toUrlFunction | 接口所属功能注释获取 |
205+
206+
207+
208+
209+
210+
[maven_svg]: https://img.shields.io/badge/Maven-1.1.7-brightgreen.svg
211+
[maven]: https://search.maven.org/search?q=io.github.afkt

‎src/main/java/javadoc/dev_utils/readme/DevHttpCapture_READMEMain.java‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,12 @@ private static void createREADMEHead(
3737
// template readme content
3838
byte[] bytes = FileUtils.readFileBytes(templatePath);
3939
String templateContent = new String(bytes);
40-
4140
// 保存 README 内容
42-
builder.append(String.format(
43-
templateContent, ApiConfig.DEV_HTTP_CAPTURE_VERSION,
44-
catalog
45-
));
41+
templateContent = templateContent.replaceAll(
42+
"DEVersion", ApiConfig.DEV_ENVIRONMENT_VERSION
43+
);
44+
// 保存 README 内容
45+
builder.append(templateContent);
4646
}
4747

4848
/**

‎src/main/java/javadoc/dev_utils/readme/template/DEV_README_API.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ implementation 'io.github.afkt:DevJava:【DevJava-vn】'
238238
[DevHttpCapture API]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/README.md
239239
[DevHttpCapture ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/CHANGELOG.md
240240
[DevEnvironment API]: https://github.com/afkT/DevUtils/blob/master/lib/Environment
241-
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/DevEnvironment/CHANGELOG.md
241+
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/CHANGELOG.md
242242
[DevDeprecated API]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/README.md
243243
[DevDeprecated ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/CHANGELOG.md
244244
[DevJava API]: https://github.com/afkT/DevUtils/blob/master/lib/DevJava/README.md

‎src/main/java/javadoc/dev_utils/readme/template/DEV_README_PROJECT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ implementation 'io.github.afkt:DevJava:【DevJava-vn】'
238238
[DevHttpCapture API]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/README.md
239239
[DevHttpCapture ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/CHANGELOG.md
240240
[DevEnvironment API]: https://github.com/afkT/DevUtils/blob/master/lib/Environment
241-
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/DevEnvironment/CHANGELOG.md
241+
[DevEnvironment ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/Environment/CHANGELOG.md
242242
[DevDeprecated API]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/README.md
243243
[DevDeprecated ChangeLog]: https://github.com/afkT/DevUtils/blob/master/lib/DevDeprecated/CHANGELOG.md
244244
[DevJava API]: https://github.com/afkT/DevUtils/blob/master/lib/DevJava/README.md

‎src/main/java/javadoc/dev_utils/readme/template/DevHttpCapture_README.md‎

Lines changed: 77 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,44 @@
11

2-
## Gradle
2+
## DevHttpCapture
3+
4+
* 该库主要对使用 OkHttp 网络请求库的项目，提供 Http 抓包功能，并支持抓包数据加密存储。
5+
6+
* **并且是以 Module ( ModuleName Key ) 为基础，支持组件化不同 Module 各自的抓包功能**，支持实时开关抓包功能、可控 Http 拦截过滤器。
7+
8+
* 内置两个 Http 抓包拦截器，CallbackInterceptor ( 无存储逻辑，进行回调通知 )、HttpCaptureInterceptor ( 存在存储抓包数据逻辑 )
9+
10+
* `DevHttpCaptureCompiler` 提供对 `DevHttpCapture` 抓包库可视化功能
311

4-
```gradle
5-
// DevHttpCapture - OkHttp 抓包工具库
6-
implementation 'io.github.afkt:DevHttpCapture:%s'
7-
```
812

9-
## 目录结构
13+
### 最新版本
1014

11-
%s
15+
module | DevHttpCapture | DevHttpCaptureCompiler | DevHttpCaptureCompilerRelease
16+
:---:|:---:|:---:|:---:
17+
version | [![][maven_svg]][maven] | [![][maven_svg]][maven] | [![][maven_svg]][maven]
1218

13-
## 框架功能介绍
1419

15-
> 该库主要对使用 OkHttp 网络请求库的项目，提供 Http 抓包功能，并支持抓包数据加密存储。
16-
>
17-
> **并且是以 Module ( ModuleName Key ) 为基础，支持组件化不同 Module 各自的抓包功能**，支持实时开关抓包功能、可控 Http 拦截过滤器。
18-
>
19-
> 内置两个 Http 抓包拦截器，CallbackInterceptor ( 无存储逻辑，进行回调通知 )、HttpCaptureInterceptor ( 存在存储抓包数据逻辑 )
20+
### Gradle
21+
22+
```groovy
23+
dependencies {
24+
// DevHttpCapture - OkHttp 抓包工具库
25+
implementation 'io.github.afkt:DevHttpCapture:DEVersion'
26+
27+
// DevHttpCaptureCompiler - OkHttp 抓包工具库 ( 可视化功能 )
28+
debugImplementation 'io.github.afkt:DevHttpCaptureCompiler:DEVersion'
29+
releaseImplementation 'io.github.afkt:DevHttpCaptureCompilerRelease:DEVersion'
30+
}
31+
```
32+
2033

2134
### 使用示例
2235

2336
```kotlin
37+
38+
// ==================
39+
// = DevHttpCapture =
40+
// ==================
41+
2442
// 添加 Http 抓包拦截处理
2543
DevHttpCapture.addInterceptor(
2644
OkHttpClient.Builder, moduleName
@@ -31,25 +49,29 @@ DevHttpCapture.removeInterceptor(moduleName)
3149

3250
// 更新对应 Module Http 抓包拦截处理
3351
DevHttpCapture.updateInterceptor(moduleName, capture)
34-
```
35-
36-
## 事项
37-
38-
- 部分 API 更新不及时或有遗漏等，`具体以对应的工具类为准`
3952

40-
- [检测代码规范、注释内容排版，API 文档生成](https://github.com/afkT/JavaDoc)
53+
// ===================================
54+
// = DevHttpCaptureCompiler 抓包可视化 =
55+
// ===================================
4156

42-
- [Change Log](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/CHANGELOG.md)
4357

44-
## API
58+
// 显示所有 Module 抓包数据
59+
DevHttpCaptureCompiler.start(context)
60+
// 显示指定 Module 抓包数据
61+
DevHttpCaptureCompiler.start(context, moduleName)
4562

63+
// =======
64+
// = 可选 =
65+
// =======
4666

47-
- dev | 根目录
48-
- [capture](#devcapture) | Http 抓包实现代码
49-
67+
// 添加接口所属功能注释
68+
DevHttpCaptureCompiler.putUrlFunction(moduleName, UrlFunctionGet)
69+
// 移除接口所属功能注释
70+
DevHttpCaptureCompiler.removeUrlFunction(moduleName)
71+
```
5072

51-
## <span id="dev">**`dev`**</span>
5273

74+
## DevHttpCapture API
5375

5476
* **OkHttp 抓包工具库 ->** [DevHttpCapture.kt](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/DevHttpCapture/src/main/java/dev/DevHttpCapture.kt)
5577

@@ -157,4 +179,33 @@ DevHttpCapture.updateInterceptor(moduleName, capture)
157179
| callResponseBodyFailed | 生成错误响应体信息 |
158180
| callResponseBody | 生成响应体信息 Map |
159181
| converterRequestBody | 转换请求体信息 Map |
160-
| callEnd | 抓包结束 |
182+
| callEnd | 抓包结束 |
183+
184+
185+
## DevHttpCaptureCompiler API
186+
187+
* **OkHttp 抓包工具库 ->** [DevHttpCaptureCompiler.kt](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/DevHttpCaptureCompiler/src/main/java/dev/DevHttpCaptureCompiler.kt)
188+
189+
| 方法 | 注释 |
190+
| :- | :- |
191+
| finishAllActivity | 结束所有 Activity |
192+
| start | 跳转抓包数据可视化 Activity |
193+
| putUrlFunction | 添加接口所属功能注释 |
194+
| removeUrlFunction | 移除接口所属功能注释 |
195+
196+
197+
## <span id="devcapture">**`dev.capture`**</span>
198+
199+
200+
* **接口所属功能注释获取 ->** [UrlFunctionGet.kt](https://github.com/afkT/DevUtils/blob/master/lib/HttpCapture/DevHttpCaptureCompiler/src/main/java/dev/capture/UrlFunctionGet.kt)
201+
202+
| 方法 | 注释 |
203+
| :- | :- |
204+
| toUrlFunction | 接口所属功能注释获取 |
205+
206+
207+
208+
209+
210+
[maven_svg]: https://img.shields.io/badge/Maven-DEVersion-brightgreen.svg
211+
[maven]: https://search.maven.org/search?q=io.github.afkt

0 commit comments

Comments
 (0)