MRAM与8位单片机组合：工业嵌入式高频数据存储与掉电保存方案
2026/10/4 16:57:57
Fast Note Sync Service REST API 完全参考：用 100+ 个接口自动化管理 Obsidian 笔记
【免费下载链接】fast-note-sync-serviceHigh-performance, low-latency note synchronization, online management, and remote REST API service platform.项目地址: https://gitcode.com/gh_mirrors/fa/fast-note-sync-service
Fast Note Sync Service（简称 FNS）是一款高性能、低延迟的 Obsidian 笔记同步服务，提供在线管理与远程REST API能力。基于 Golang + WebSocket + React 构建，它支持多设备笔记同步、附件分片传输、笔记历史版本、Git 自动推送与多云备份，并通过 80+ 个 REST 接口（加上 WebSocket 实时通道与 MCP 协议）实现超过 100 个自动化操作入口，让脚本、CI 任务和 AI 助手都能直接读写你的笔记库 📚。
REST API 快速入门：认证方式与统一响应结构
所有接口定义由 OpenAPI 生成，完整文档见 REST_API.md，机器可读规格见 swagger.yaml，接口源码位于 internal/routers/api_router/ 目录。
| 项目 | 说明 |
|---|---|
| Base URL | http://{host}:9000/api |
| 认证方式 | 请求头携带Authorization: {token}，Token 由登录接口签发 |
| 分页参数 | page（默认 1）、page_size（默认 10，最大 100） |
所有接口返回统一 JSON 结构：
{ "code": 1, "status": true, "message": "OK", "data": { "list": [], "pager": { "page": 1, "pageSize": 10, "totalRows": 0 } } }常见错误码：407用户名不存在、414保险库不存在、428笔记不存在、445需要管理员权限、507未登录、508会话过期。排查自动化任务时，先看code字段即可快速定位问题。
11 个功能模块 × 80+ REST 接口全景速览
| 模块 | 接口数 | 核心能力 |
|---|---|---|
| Note 笔记 | 14 | CRUD、追加/前置内容、正则替换、双向链接、历史版本 |
| File 附件 | 7 | 内容读写、回收站、重命名 |
| Folder 文件夹 | 7 | 文件夹 CRUD 与目录树 |
| Share 分享 | 6 | 分享链接、密码保护、短链 |
| Backup 备份 | 5 | S3/OSS/WebDAV 备份与历史查询 |
| GitSync Git 同步 | 7 | 自动推送到远程仓库、参数校验 |
| Storage 存储 | 5 | 多云存储配置与连接校验 |
| Setting 设置 | 5 | 键值设置与.obsidian配置同步 |
| Vault 保险库 | 4 | Vault 管理 |
| User 用户 | 4 | 注册、登录、改密 |
| System/Config 系统 | 25 | 健康检查、运维操作、管理员配置 |
笔记管理 API：自动创建、追加与批量替换 Obsidian 笔记
这是最高频使用的模块，handler_note.go 中的 14 个端点覆盖了笔记的完整生命周期：
| 接口 | 方法 | 用途 |
|---|---|---|
/api/note | GET / POST / DELETE | 读取、创建/修改/重命名、删除（进回收站） |
/api/note/append、/api/note/prepend | POST | 末尾追加 / 开头插入（frontmatter 之后），不覆盖原文 |
/api/note/replace | POST | 查找替换，支持正则表达式 |
/api/note/move、/api/note/rename | POST | 移动与重命名 |
/api/note/recycle-clear | DELETE | 清空回收站 |
/api/note/restore | PUT | 从回收站恢复 |
/api/note/backlinks、/api/note/outlinks | GET | 反向链接 / 出链查询 |
/api/note/frontmatter | PATCH | 批量增删 YAML frontmatter 字段 |
几个自动化场景特别值得注意：
- 每日日志：调用
POST /api/note/append把会议记录追加到Daily/2026-10-04.md，天然幂等，不破坏已有内容； - 批量清理：
POST /api/note/replace传入正则，一次统一全库旧模板； - 知识图谱构建：
backlinks+outlinks双接口可直接导出双向链接关系； - 全文检索：
GET /api/notes内置 SQLite FTS5 全文搜索引擎，searchMode支持path、content、regex三种模式，配合sortBy/sortOrder自由排序。
文件夹与保险库 API：批量整理 Vault 目录结构
| 接口 | 方法 | 用途 |
|---|---|---|
/api/vault | GET / POST / DELETE | 保险库列表 / 创建或更新 / 删除 |
/api/folder | GET / POST / DELETE | 文件夹详情 / 创建 / 删除 |
/api/folder/tree | GET | 一次性拉取整棵目录树 |
/api/folder/files、/api/folder/notes | GET | 列出文件夹内的附件与笔记 |
配合文件夹同步（支持创建、重命名、移动、删除），可以在脚本中先建好Inbox、Projects、Archive骨架，再批量移动笔记归档。
附件文件 API：图片与文档同步接口一览
| 接口 | 方法 | 用途 |
|---|---|---|
/api/file | GET / DELETE | 获取附件内容 / 删除 |
/api/file/info | GET | 附件元信息 |
/api/files | GET | 分页文件列表 |
/api/file/rename、/api/file/restore | POST / PUT | 重命名 / 从回收站恢复 |
/api/file/recycle-clear | DELETE | 清空附件回收站 |
大文件采用分片上传/下载，分片大小可配置，适合脚本批量同步图片或 PDF 资料库。
备份与存储配置 API：S3、OSS、WebDAV 一键备份
| 接口 | 方法 | 用途 |
|---|---|---|
/api/backup/config | POST / DELETE | 创建或更新备份配置 |
/api/backup/configs | GET | 配置列表 |
/api/backup/execute | POST | 手动触发一次备份 |
/api/backup/historys | GET | 备份历史（分页） |
/api/storage | GET / POST / DELETE | 存储配置管理 |
/api/storage/validate | POST | 校验存储连接是否可用 |
支持 S3、OSS、R2、WebDAV、本地文件系统等协议，可配置定时全量/增量 ZIP 备份、过期保留天数自动清理，以及 Vault 到远端存储的单向镜像同步。
Git 自动同步：笔记变更自动推送远程仓库
/api/git-sync/*共 7 个端点，包括POST /api/git-sync/validate（参数校验）、POST /api/git-sync/config/execute（手动触发）、GET /api/git-sync/histories（同步历史）。笔记或附件一旦变更，服务端自动 commit 并 push 到远程 Git 仓库，任务完成后自动释放内存，实现"云端 + Git 双保险"。
分享 API：生成带密码保护的笔记分享链接
| 接口 | 方法 | 用途 |
|---|---|---|
/api/share | GET / POST / DELETE | 查询分享 / 创建分享 / 取消分享 |
/api/share/note、/api/share/file | GET | 凭分享 Token 只读访问笔记或附件 |
/api/share/password、/api/share/short_link | — | 密码保护与短链生成 |
/api/shares | GET | 分享列表（支持排序分页） |
创建分享时会自动解析笔记中引用的图片、音视频附件并授权，无需手动逐个添加。
用户与系统运维 API：从登录到健康检查的完整流程
认证四连（handler_user.go）：
POST /api/user/register → 注册（服务器可关闭开放注册） POST /api/user/login → 登录，返回 Token（后续所有接口的门票） GET /api/user/info → 当前用户信息 POST /api/user/change_password → 修改密码运维接口（需管理员权限）：GET /api/health（探针健康检查，适合接入监控告警）、GET /api/version与/api/version/probe（版本与升级源延迟探测）、GET /api/admin/systeminfo（运行时信息）、GET /api/admin/restart//api/admin/gc//api/admin/upgrade（重启、手动 GC、在线升级）、GET /api/admin/ws_clients（当前 WebSocket 在线客户端）。
MCP 协议与 WebSocket：让 AI 直接操作你的笔记库
REST API 只是 FNS 的"第一层"能力：
- WebSocket 实时通道：笔记变更毫秒级推送到所有在线设备，协议细节见 SyncProtocol.md；
- 原生 MCP 支持：FNS 可作为 MCP Server 接入 Cherry Studio、Cursor 等 AI 客户端，让 AI 直接读写个人笔记，改动实时同步到全部设备。技能描述见 docs/skills/fns-mcp/，MCP 接口定义见 mcp_dto.go。
快速上手与资源汇总
推荐用 Docker 部署（镜像定义见 Dockerfile，编排文件见 docker/docker-compose.yaml）。启动后默认 9000 端口提供 Web 控制台，REST 路由挂在/api下，拿到登录返回的 Token 后即可开始自动化之旅 🚀。
| 资源 | 路径 |
|---|---|
| REST API 完整文档 | docs/REST_API.md |
| OpenAPI 规格（Swagger） | docs/swagger.yaml |
| WebSocket 同步协议 | docs/SyncProtocol.md |
| 接口路由源码 | internal/routers/api_router/ |
| 请求模型定义 | internal/dto/ |
需要从零搭建时，克隆仓库即可开始：
git clone https://gitcode.com/gh_mirrors/fa/fast-note-sync-service掌握这套 REST API 后，无论是每日日志自动追加、全库正则清理、目录批量归档，还是把笔记库接入 CI 与 AI 工作流，都能在几行脚本内完成。
【免费下载链接】fast-note-sync-serviceHigh-performance, low-latency note synchronization, online management, and remote REST API service platform.项目地址: https://gitcode.com/gh_mirrors/fa/fast-note-sync-service
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考