阅读Sigma Web服务与API完全指南：如何远程管理书源与一键导入

阅读Sigma Web服务与API完全指南如何远程管理书源与一键导入【免费下载链接】legado-E阅读Sigma是legado的继承保持开源免费延续开源精神。项目地址: https://gitcode.com/gh_mirrors/legado2/legado-E阅读Sigmalegado-E是一款开源免费的 Android 阅读应用其内置的Web 服务让你不用碰手机屏幕就能通过浏览器或脚本远程管理书源、批量导入订阅源、拉取正文内容。本文带你从零开启 Web 服务并附完整 API 接口清单 什么是阅读Sigma的Web服务开启后App 会在手机上起一个本地 HTTP 服务器默认端口1234并提供一个长连接 WebSocket 服务端口1235对外提供书源管理插入 / 查询 / 删除书源与 RSS 订阅源书籍操作获取书架、目录、正文、封面、保存阅读进度替换规则增删改查与在线测试调试通道搜索书籍、书源调试、订阅源调试WebSocket核心实现位于 web 服务目录接口文档可参考项目根目录的 api.md。如何开启Web服务3步上手打开 App进入底部「我的」页面入口代码见 MyFragment.kt找到「Web 服务」开关并打开服务即由 WebService.kt 在后台启动在电脑浏览器访问http://手机IP:1234/验证连通性同一局域网内即可 小技巧支持锁屏保活唤醒配置可搜索webServiceWakeLock相关偏好项远程访问时把文档里的127.0.0.1换成手机 IP 即可。完整API接口清单以下接口默认前缀为http://手机IP:1234实现分布在 BookSourceController.kt、BookController.kt 等控制器中。书源与订阅源管理功能URL方法说明插入单个书源/saveBookSourcePOSTBODY 为单个书源 JSON批量导入书源/saveBookSourcesPOSTBODY 为书源 JSON数组批量导入订阅源/saveRssSourcesPOST同上RSS 版获取指定书源/getBookSource?urlxxxGET按源地址查询获取所有书源/getBookSourcesGET返回全部数据批量删除书源/deleteBookSourcesPOSTBODY 为书源 JSON 数组书源 JSON 格式可对照实体定义 BookSource.kt内置示例见 bookSources.json。书籍与阅读内容功能URL方法说明插入书籍/saveBookPOST启用缓存后可取目录正文删除书籍/deleteBookPOST试读完可清理获取书架/getBookshelfGET支持多种排序获取章节列表/getChapterList?urlxxxGET缓存为空时自动刷新获取正文/getBookContent?urlxxxindex1GETindex为章节序号获取封面/cover?pathxxxGET默认封面示意如下图获取正文图片/image?urlpathwidthGET支持指定宽度保存阅读进度/saveBookProgressPOST格式见 BookProgress.kt替换规则管理功能URL方法获取全部规则/getReplaceRulesGET新增规则/saveReplaceRulePOST删除规则/deleteReplaceRulePOST在线测试规则/testReplaceRulePOST规则结构参考 ReplaceRule.kt测试接口传入ruletext即可返回替换结果非常适合写脚本批量清洗内容。WebSocket 实时通道功能地址消息格式搜索在线书籍ws://手机IP:1235/searchBook{ key: 关键词 }书源调试ws://手机IP:1235/bookSourceDebug{ key, tag }订阅源调试ws://手机IP:1235/rssSourceDebug{ key, tag }实现分别位于 BookSearchWebSocket.kt 等文件中。一键导入书源的最快姿势想让电脑上的书源库秒上手机只需两条命令思路GET http://手机IP:1234/getBookSources → 先看现有书源 POST http://手机IP:1234/saveBookSources → BODY 粘贴书源JSON数组批量入库批量导入时控制器会逐个校验源名称和 URL 非空合法源全部写入数据库并回传成功列表实现真正意义上的一键导入 ⚡Vue3 Web端浏览器里看书、编源除了裸 API项目还内置了一套 Vue3 前端位于 modules/web 目录说明见 modules/web/README.mdWeb 书架/#/路由打开书架在线阅读界面由 BookShelf.vue 与 BookChapter.vue 构成✍️书源编辑器/#/bookSource路由可视化编辑书源规则SourceEditor.vue订阅源编辑器/#/rssSource路由管理 RSS 源在线调试内置 SourceDebug.vue 通过 WebSocket 实时调试书源浏览器兼容 Edge ≥ 85、Chrome ≥ 85、Firefox ≥ 79、Safari ≥ 14.1日常在 PC 上维护书源库非常顺手。Content Provider安卓应用间的数据桥梁除了 HTTP阅读Sigma 还提供 ReaderProvider.kt允许其他安卓应用直接读写书源、书籍、目录与正文需声明io.legado.READ_WRITE权限providerHost为包名.readerProvider如io.legado.app.release.readerProvider典型用法content://providerHost/bookSources/query获取全部书源适合想在自己的 App 里集成阅读能力的开发者。安全注意事项 Web 服务默认只对局域网开放公网环境请谨慎暴露避免他人增删你的书源与书籍删除类接口deleteBookSources、deleteBook操作不可逆脚本调用前先getBookSources/getBookshelf备份数据试读流程先saveBook启用缓存 → 取目录正文 → 不加入书架则deleteBook清理掌握以上内容你已能完整玩转阅读Sigma 的 Web 服务从开启服务、一键导入书源到用 API 搭建自己的阅读数据管道。更多细节可翻阅 api.md 与 web 服务目录 的源码注释。【免费下载链接】legado-E阅读Sigma是legado的继承保持开源免费延续开源精神。项目地址: https://gitcode.com/gh_mirrors/legado2/legado-E创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考