Merge pull request #4 from Chave0v0/dev

update README.md

Author: Chave0v0

README.md

@@ -13,6 +13,180 @@ Java 版本不仅更好地与 BurpSuite 环境集成，而且通过减少第三
 
 ## 功能
 
-- **API 高亮显示**：根据特定的规则和模式匹配 API 请求。
-- **敏感信息检测**：针对泄漏或敏感信息进行标记和提示。
-- **未授权访问漏洞检测**：支持精确匹配、正则表达式匹配等。
+### API 高亮
+
+#### 导入 API
+
+导入格式如下：
+
+- \<Path\>
+  - 仅传入 Path 时，无论是否勾选 ``检查Method``，默认匹配所有 HTTP 方法。
+  - \<Path\> 支持解析 `PathVariable` ，格式为 `{任意字符}`。
+- \<Method\>,\<Path\>
+  - `Method` 与 `Path` 之间使用 `,` 分隔。当勾选 ``检查Method`` 时，当前 Path 仅匹配指定 HTTP 方法。
+  - \<Path\> 支持解析 `PathVariable` ，格式为 `{任意字符}`。
+- xxxxx
+  - 传入任意字符进行匹配，通常用于模糊匹配。
+
+![image-20250131152949132](assets/image-20250131152949132.png)
+
+![image-20250131153024127](assets/image-20250131153024127.png)
+
+#### 选择匹配模式
+
+不同匹配模式仅针对 Path。
+
+##### 精确匹配
+
+选择精确匹配模式时，不支持 `启用URL编码`、`检查完整数据包`。
+
+精确匹配仅匹配 API，不匹配 GET 请求参数，且需要 API 完全匹配。
+
+导入如下内容。
+
+![image-20250131153251402](assets/image-20250131153251402.png)
+
+此时可匹配接口 `/user/register`，`/user/login`，`/user/chave/info`。
+
+但无法匹配 `/test/user/login/test`，`/user/loginabc`，`/user/chave/infomation`，`/test/user/chave/info` 以及 `参数中的xxx`。
+
+![image-20250131143303914](assets/image-20250131143303914.png)
+
+##### 半模糊匹配
+
+选择半模糊匹配模式时，不支持 `启用URL编码`、`检查完整数据包`。
+
+半模糊匹配仅匹配 API，不匹配 GET 请求参数，但支持匹配不完全相同 API。
+
+导入如下内容。
+
+![image-20250131153522783](assets/image-20250131153522783.png)
+
+此时可匹配接口 `/user/login`，`/user/register`，`/user/chave/info`，`/test/user/login/test`，`/test/user/chave/info/abc`。
+
+但无法匹配 `/user/loginabc`，`/user/chave/infomation`，`/xxx`，`/testxxx` 以及 `参数中的xxx`。
+
+![image-20250131143734141](assets/image-20250131143734141.png)
+
+##### 模糊匹配
+
+选择模糊匹配模式时，支持 `启用URL编码`、`检查完整数据包`。
+
+模糊匹配在默认情况下，匹配 `Path + 参数`。
+
+导入如下内容。
+
+![image-20250131153624442](assets/image-20250131153624442.png)
+
+###### 解析 PathVariable
+
+切换到模糊匹配模式时，会弹出窗口，选择是否解析 PathVariable。选择 `是` 则解析，选择 `否` 则不解析。
+
+当解析 PathVariable 时，此时可匹配接口 `/test/user/abc/infomation` 与参数 `/test/user/abc/infoamtion`，`/test/user/{name}/infomation`。
+
+![image-20250131151601732](assets/image-20250131151601732.png)
+
+当选择不解析 PathVariable 时，此时无法匹配接口 `/test/user/abc/infoamtion` 与参数 `/test/user/abc/infoamtion`，仅可匹配参数 `/test/user/{name}/infomation`。
+
+![image-20250131151831909](assets/image-20250131151831909.png)
+
+###### 启用 URL 编码
+
+当未勾选 `启用URL解码` 时，此时无法匹配参数中经过 URL 编码的 `a b c d e f g`。
+
+![image-20250131153719159](assets/image-20250131153719159.png)
+
+![image-20250131152224779](assets/image-20250131152224779.png)
+
+勾选 `启用URL解码`，此时会对 request 进行 URL 解码，此时可匹配参数中经过 URL 编码的 `a b c d e f g`。
+
+![image-20250131153838072](assets/image-20250131153838072.png)
+
+![image-20250131153912482](assets/image-20250131153912482.png)
+
+###### 检查完整数据包
+
+当未勾选 `检查完整数据包` 时，此时仅检查请求 `Path + 参数`，未检查数据包中其他内容。
+
+此时无法匹配请求体中的 `a b c d e f g` 与 `xxx`。
+
+![image-20250131155246057](assets/image-20250131155246057.png)
+
+勾选 `检查完整数据包时` 时，此时将检查整个数据包，此时可匹配 `a b c d e f g`，`xxx`。
+
+![image-20250131155558419](assets/image-20250131155558419.png)
+
+![image-20250131155745214](assets/image-20250131155745214.png)
+
+该功能可与 `启用URL解码` 同时开启，可匹配完整请求中被 URL 编码的数据。
+
+![image-20250131160031773](assets/image-20250131160031773.png)
+
+#### 检查 Method
+
+勾选 `检查Method` 后，需要 Method 与 Path 同时匹配才会高亮。
+
+若 Method 为空，勾选 `检查Method` 依然匹配所有 HTTP 方法。
+
+#### 检查 history
+
+点击 `检查history` 后，会根据当前配置情况重新检查 history 中所有记录，原高亮记录会被覆盖。
+
+#### 切换测试状态
+
+选择一条或多条 API，点击 `切换测试状态`，可切换选中条目测试状态。
+
+当 **State** 为 **true** 时，该条 API 不再进行匹配。
+
+![image-20250131201354108](assets/image-20250131201354108.png)
+
+![image-20250131201535978](assets/image-20250131201535978.png)
+
+#### 操作 API 列表
+
+##### 修改数据
+
+- 修改 Method
+  - 仅支持修改为 GET、POST、PUT、DELETE、OPTIONS。
+- 修改 State
+  - 仅支持修改为 true、false。
+- 修改 Path、Result、Note、Domain
+  - 无限制
+
+##### 删除数据
+
+选中一条或多条 API，按下退格键即可删除选中条目。
+
+##### 列表排序
+
+暂不支持...
+
+#### 查找 API
+
+##### 快速查找
+
+- \<Path\>：精确查找 Path，并选中。
+- \<Method\>,\<Path\>：精确查找 Method + Path，并选中。
+- *：选中全部条目。
+
+![image-20250131203231727](assets/image-20250131203231727.png)
+
+![image-20250131203259330](assets/image-20250131203259330.png)
+
+##### 条件查找
+
+按条件信息查找，如 `method=get`，`path=/service`，`result=xxx`，`state=true` 等。
+
+不支持多条件搜索，不支持模糊搜索。
+
+![image-20250131204156562](assets/image-20250131204156562.png)
+
+![image-20250131204216952](assets/image-20250131204216952.png)
+
+![image-20250131204256345](assets/image-20250131204256345.png)
+
+## 更新计划
+
+- HaE 规则敏感信息检查
+- API 未授权访问检查
+- 列表排序