Merge pull request #1 from wanan99/patch-1

Update rules-Introduction.md
freenovel123 · Nov 25, 2024 · 7182a9d · 7182a9d
2 parents a5509f1 + a74a406
commit 7182a9d
Showing 1 changed file with 44 additions and 5 deletions.
diff --git a/docs/制作源/rules-Introduction.md b/docs/制作源/rules-Introduction.md
@@ -2,16 +2,55 @@
 
 ## 参数说明
 
+### 公共内置请求参数
+| 参数名称   | 说明             | 用例                     | 值类型示例                |
+|:----------|------------------|:------------------------|:------------------------|
+| params    | 请求参数         | 用例：`config.params`    |                         |
+| engine    | 源引擎类型       | 用例：`config.engine`    | xpath、jsonpath          |
+| method    | 请求类型         | 用例：`config.method`    | POST，GET                |
+| host      | 站点地址         | 用例：`config.host`      |                         |
+| header    | 请求头           | 优先级别：正式请求头>浏览器过盾请求头>公共请求头 | 用例：`config.header` |
+| mode      | 请求模式         | 用例：`config.mode`      | http、webview            |
+| requestEncode | 请求编码方式   | 用例：`config.requestEncode` | utf-8、gbk              |
+| responseEncode | 响应编码方式   | 用例：`config.responseEncode` | utf-8、gbk              |
+| cookies   | cookies信息      | 用例：`config.cookies`   |                         |
+| openParams| 开放参数，可自定义 | 用例：`config.openParams`|                         |
+| verifyCode| 验证码           | 用例：`config.verifyCode`|                         |
 ### 搜索规则
-
+| 参数名称 | 说明 | 用例 |
+|:---|:---|:---|
+| keyword | 搜索关键词 | 用例：`config.keyword` |
+| url | 搜索地址 | 用例：`config.url` |
 ### 详情规则
 
 ### 章节列表规则
-
+| 参数名称   | 说明                             | 用例                     |
+|:----------|:---------------------------------|:------------------------|
+| bookUrl   | 章节列表url                       | 用例：`config.bookUrl`   |
+| infoUrl   | 书籍信息url                       | 如果书籍详情有规则，会先调用`infoUrl`请求，并获取`bookUrl` |
+| bookName  | 书籍名称                         | 用例：`config.bookName`  |
+| bookAuthor| 作者                             | 用例：`config.bookAuthor`|
+| url       | 章节列表请求地址                   | 用例：`config.url`      |
+| pageIndex | 页码                             | 用例：`config.pageIndex`|
+| pageStart | 起始章节页数（老版本参数不建议使用） | 用于章节规则拼接，如第二章起，标记2 |
 ### 正文规则
-
+| 参数名称   | 说明               | 用例                     |
+|:----------|:-------------------|:------------------------|
+| bookUrl   | 章节列表Url         | 用例：`config.bookUrl`   |
+| bookName  | 书籍名称           | 用例：`config.bookName`  |
+| bookAuthor| 作者               | 用例：`config.bookAuthor`|
+| chapterUrl| 章节详情Url         | 用例：`config.chapterUrl`|
+| infoUrl   | 书籍详情Url         | 用例：`config.infoUrl`   |
+| chapterName| 章节名称         | 用例：`config.chapterName`|
+| url       | 正文请求地址        | 用例：`config.url`      |
+| pageIndex | 页码               | 用例：`config.pageIndex`|
+| pageStart | 起始章节页数（老版本参数不建议使用） | 用于正文规则拼接，如第二章起，标记2 |
+| playUrl   | 如果`playUrl`规则为空，自动获取正文url和正文header | 用例：`config.playUrl`  |
 ### 发现规则
-
+| 参数名称 | 说明             | 用例                     |
+|:--------|------------------|:------------------------|
+| url     | 发现请求地址      | 用例：`config.url`       |
+| pageIndex | 章节页数序列      | 用例：`config.pageIndex` |
 ### 表达式
 
 APP内置了各种常用的表达式，可以进行替换获取和处理操作。
@@ -29,4 +68,4 @@ APP内置了各种常用的表达式，可以进行替换获取和处理操作
 | `##正则表达式#替换字符` | 正则替换 | `##a#b` | 替换一次 |
 | `##正则表达式##替换字符` | 正则替换 | `##a##b` | 替换所有 |
 | `##正则表达式` | 正则替换 | `##a` | 过滤所有 |
-| `##正则表达式#$1` | 正则替换 | `##(*.?)#$1` | 取值，如果有子串，可按照$1\$2\$3...直接取值 |
+| `##正则表达式#$1` | 正则替换 | `##(*.?)#$1` | 取值，如果有子串，可按照$1\$2\$3...直接取值 |