From 82bef81172a3d246de021227d8da28fca28b02db Mon Sep 17 00:00:00 2001
From: Xwite <82232510+Xwite@users.noreply.github.com>
Date: Mon, 27 Mar 2023 07:40:52 +0800
Subject: [PATCH] Update api.md

---
 api.md | 77 +++++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 65 insertions(+), 12 deletions(-)

diff --git a/api.md b/api.md
index d63042fca..1a21a1b04 100644
--- a/api.md
+++ b/api.md
@@ -1,6 +1,6 @@
-# 阅读API
+# 阅读[API](/app/src/main/java/io/legado/app/api/controller)
 
-## 对于Web的配置
+## 对于[Web](/app/src/main/java/io/legado/app/web/)的配置
 
 您需要先在设置中启用"Web 服务"。
 
@@ -14,7 +14,7 @@
 #### 插入单个书源
 
 请求BODY内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/BookSource.kt)
 
 ```
 URL = http://127.0.0.1:1234/saveSource
@@ -24,7 +24,7 @@ Method = POST
 #### 插入多个书源or订阅源
 
 请求BODY内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
 
 ```
 URL = http://127.0.0.1:1234/saveBookSources
@@ -51,7 +51,7 @@ Method = GET
 #### 删除多个书源or订阅源
 
 请求BODY内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
 
 ```
 URL = http://127.0.0.1:1234/deleteBookSources
@@ -59,10 +59,55 @@ URL = http://127.0.0.1:1234/deleteRssSources
 Method = POST
 ```
 
+#### 获取替换规则
+
+```
+URL = http://127.0.0.1:1234/getReplaceRules
+Method = GET
+```
+
+#### 替换规则管理
+
+请求BODY内容为`JSON`字符串，  
+替换规则参考[这个文件](/app/src/main/java/io/legado/app/data/entities/ReplaceRule.kt)。
+
+##### 删除
+
+```
+URL = http://127.0.0.1:1234/deleteReplaceRule
+Method = POST
+Body = [ReplaceRule]
+```
+##### 插入
+
+```
+URL = http://127.0.0.1:1234/saveReplaceRule
+Method = POST
+Body = [ReplaceRule]
+```
+
+##### 测试
+
+返回测试文本text替换结果
+
+```
+URL = http://127.0.0.1:1234/testReplaceRule
+Method = POST
+Body = { rule: [ReplaceRule], text: [String] }
+```
+
+#### 搜索在线书籍
+
+```
+URL = http://127.0.0.1:1234/searchBooks
+Method = POST
+Body = { key: [String] }
+```
+
 #### 插入书籍
 
 请求BODY内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt)。
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/Book.kt)。
 
 ```
 URL = http://127.0.0.1:1234/saveBook
@@ -103,17 +148,25 @@ URL = http://127.0.0.1:1234/cover?path=xxxxx
 Method = GET
 ```
 
+#### 获取正文图片
+
+```
+URL = http://127.0.0.1:1234/image?url=${bookUrl}&path=${picUrl}&width=${width}
+Method = GET
+```
+
 #### 保存书籍进度
 
 请求BODY内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookProgress.kt)。
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/BookProgress.kt)。
 
 ```
 URL = http://127.0.0.1:1234/saveBookProgress
 Method = POST
 ```
 
-### Content Provider
+### [Content Provider](/app/src/main/java/io/legado/app/api/ReaderProvider.kt)
+
 
 * 需声明`io.legado.READ_WRITE`权限
 * `providerHost`为`包名.readerProvider`, 如`io.legado.app.release.readerProvider`,不同包的地址不同,防止冲突安装失败
@@ -122,7 +175,7 @@ Method = POST
 #### 插入单个书源or订阅源
 
 创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/BookSource.kt)
 
 ```
 URL = content://providerHost/bookSource/insert
@@ -133,7 +186,7 @@ Method = insert
 #### 插入多个书源or订阅源
 
 创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
 
 ```
 URL = content://providerHost/bookSources/insert
@@ -166,7 +219,7 @@ Method = query
 #### 删除多个书源or订阅源
 
 创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
 
 ```
 URL = content://providerHost/bookSources/delete
@@ -177,7 +230,7 @@ Method = delete
 #### 插入书籍
 
 创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，  
-格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt)。
+格式参考[这个文件](/app/src/main/java/io/legado/app/data/entities/Book.kt)。
 
 ```
 URL = content://providerHost/book/insert