SiYuan API

📝 思源笔记本地API安全管家

思源笔记官方本地API,安全接管笔记本、文档、块及数据库管理,严格限定127.0.0.1/localhost环境令牌认证。

收藏
4.7k
安装
1.1k
版本
1.4.6
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

本技能提供思源笔记(SiYuan)本地HTTP API的完整封装,支持笔记本/文档/块的全生命周期管理、资源上传、属性视图(数据库)操作及受限SQL查询。采用环境变量驱动的令牌认证模式,所有调用严格限定于本地或经用户显式确认的局域网地址。

显著优点

安全边界清晰:明确禁用/api/network/forwardProxy/api/convert/pandoc等高风险端点,攻击面可控;数据库原生支持:完整封装Attribute View API,支持多选、数字、复选框等字段类型的批量更新;无第三方依赖:纯instruction-only设计,不含代理逻辑或可执行组件;SQL保守策略:优先只读查询,强制LIMIT限制结果集,规避破坏性操作。

潜在局限

  • 地域锁定:仅支持本地/局域网部署,无法直接操作远程思源实例
  • 功能阉割:主动放弃网络代理、Pandoc转换等能力,复杂格式转换需外部处理
  • 令牌管理:依赖用户手动配置环境变量,无图形化配置界面
  • 版本耦合:Attribute View API随思源版本演进,存在接口变动风险

适合人群

  • 本地思源重度用户,需自动化笔记/数据库管理
  • 科研/数据工作者,用思源数据库管理结构化实验记录
  • 隐私敏感场景,拒绝云端同步的完全本地化工作流

常规风险

令牌泄露可导致本地笔记数据被篡改;误操作SQL或文件API可能造成数据丢失。建议配合思源自带的数据备份机制使用。

SiYuan API 内容

references文件夹
手动下载zip · 5.5 kB
safe-api.mdtext/markdown
请选择文件