You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
169 lines
4.3 KiB
169 lines
4.3 KiB
# 阅读API
|
|
## 对于Web的配置
|
|
您需要先在设置中启用"Web 服务"。
|
|
## 使用
|
|
### Web
|
|
以下说明假设您的操作在本机进行，且开放端口为1234。
|
|
如果您要从远程计算机访问[阅读]，请将`127.0.0.1`替换成手机IP。
|
|
#### 插入单个书源
|
|
```
|
|
URL = http://127.0.0.1:1234/saveSource
|
|
Method = POST
|
|
```
|
|
|
|
请求BODY内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)
|
|
|
|
#### 插入多个书源
|
|
```
|
|
URL = http://127.0.0.1:1234/saveSources
|
|
Method = POST
|
|
```
|
|
|
|
请求BODY内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
|
|
|
|
#### 获取书源
|
|
```
|
|
URL = http://127.0.0.1:1234/getSource?url=xxx
|
|
Method = GET
|
|
```
|
|
|
|
获取指定URL对应的书源信息。
|
|
|
|
#### 获取所有书源
|
|
```
|
|
URL = http://127.0.0.1:1234/getSources
|
|
Method = GET
|
|
```
|
|
|
|
获取APP内的所有书源。
|
|
|
|
#### 删除多个书源
|
|
```
|
|
URL = http://127.0.0.1:1234/deleteSources
|
|
Method = POST
|
|
```
|
|
|
|
请求BODY内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
|
|
|
|
#### 插入书籍
|
|
```
|
|
URL = http://127.0.0.1:1234/saveBook
|
|
Method = POST
|
|
```
|
|
|
|
请求BODY内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt)。
|
|
|
|
#### 获取所有书籍
|
|
```
|
|
URL = http://127.0.0.1:1234/getBookshelf
|
|
Method = GET
|
|
```
|
|
|
|
获取APP内的所有书籍。
|
|
|
|
#### 获取书籍章节列表
|
|
```
|
|
URL = http://127.0.0.1:1234/getChapterList?url=xxx
|
|
Method = GET
|
|
```
|
|
|
|
获取指定图书的章节列表。
|
|
|
|
#### 获取书籍内容
|
|
|
|
```
|
|
URL = http://127.0.0.1:1234/getBookContent?url=xxx&index=1
|
|
Method = GET
|
|
```
|
|
|
|
获取指定图书的第`index`章节的文本内容。
|
|
|
|
### Content Provider
|
|
* 需声明`io.legado.READ_WRITE`权限
|
|
* `providerHost`为`包名.ReaderProvider`, 如`io.legado.app.release.ReaderProvider`,不同包的地址不同,防止冲突安装失败
|
|
* 以下出现的`providerHost`请自行替换
|
|
#### 插入单个书源
|
|
```
|
|
URL = content://providerHost/source/insert
|
|
Method = insert
|
|
```
|
|
|
|
创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)
|
|
|
|
#### 插入多个书源
|
|
```
|
|
URL = content://providerHost/sources/insert
|
|
Method = insert
|
|
```
|
|
|
|
创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
|
|
|
|
#### 获取书源
|
|
```
|
|
URL = content://providerHost/source/query?url=xxx
|
|
Method = query
|
|
```
|
|
|
|
获取指定URL对应的书源信息。
|
|
用`Cursor.getString(0)`取出返回结果。
|
|
|
|
#### 获取所有书源
|
|
```
|
|
URL = content://providerHost/sources/query
|
|
Method = query
|
|
```
|
|
|
|
获取APP内的所有书源。
|
|
用`Cursor.getString(0)`取出返回结果。
|
|
|
|
#### 删除多个书源
|
|
```
|
|
URL = content://providerHost/sources/delete
|
|
Method = delete
|
|
```
|
|
|
|
创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/BookSource.kt)，**为数组格式**。
|
|
|
|
#### 插入书籍
|
|
```
|
|
URL = content://providerHost/book/insert
|
|
Method = insert
|
|
```
|
|
|
|
创建`Key="json"`的`ContentValues`，内容为`JSON`字符串，
|
|
格式参考[这个文件](https://github.com/gedoor/legado/blob/master/app/src/main/java/io/legado/app/data/entities/Book.kt)。
|
|
|
|
#### 获取所有书籍
|
|
```
|
|
URL = content://providerHost/books/query
|
|
Method = query
|
|
```
|
|
|
|
获取APP内的所有书籍。
|
|
用`Cursor.getString(0)`取出返回结果。
|
|
|
|
#### 获取书籍章节列表
|
|
```
|
|
URL = content://providerHost/book/chapter/query?url=xxx
|
|
Method = query
|
|
```
|
|
|
|
获取指定图书的章节列表。
|
|
用`Cursor.getString(0)`取出返回结果。
|
|
|
|
#### 获取书籍内容
|
|
|
|
```
|
|
URL = content://providerHost/book/content/query?url=xxx&index=1
|
|
Method = query
|
|
```
|
|
|
|
获取指定图书的第`index`章节的文本内容。
|
|
用`Cursor.getString(0)`取出返回结果。
|
|
|