diff --git a/api.md b/api.md index 2da9c660f..dfdaaec2a 100644 --- a/api.md +++ b/api.md @@ -1,9 +1,87 @@ -#阅读API +# 阅读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,不同包的地址不同,防止冲突安装失败 @@ -88,4 +166,4 @@ Method = query ``` 获取指定图书的第`index`章节的文本内容。 -用`Cursor.getString(0)`取出返回结果。 \ No newline at end of file +用`Cursor.getString(0)`取出返回结果。