Obsidian_Rest_Api_Setup

📅 2026-06-12 ✍️ 以观其妙书院

Obsidian Local REST API 配置指南

配置状态

  • 插件安装: 进行中 (obsidian://show-plugin?id=obsidian-local-rest-api)
  • Obsidian CLI: 已安装 (v0.5.1)
  • 配置文件: C:\Users\jia'yue\.config\obsidian\obsidian.json
  • 配置步骤

    步骤 1: 安装插件

    1. 点击链接打开Obsidian: obsidian://show-plugin?id=obsidian-local-rest-api 2. 或者手动操作: - 打开Obsidian - 进入 设置第三方插件 - 关闭 安全模式 - 点击 浏览 社区插件 - 搜索 Local REST API - 点击 安装

    步骤 2: 启用插件

    1. 安装完成后,在插件列表中找到 Local REST API 2. 点击切换按钮启用插件

    步骤 3: 获取API Key

    1. 点击 Local REST API 插件旁边的 选项 按钮 2. 在设置页面中: - 启用 Enable REST API (开启REST API) - 设置 Port (端口,默认: 27124) - 点击 Generate API Key (生成API密钥) 3. 复制生成的API Key (一串长字符)

    步骤 4: 验证连接

    获取API Key后,运行以下命令测试:

    列出所有笔记库

    $env:OBSIDIAN_API_KEY="your-api-key-here" obsidian list-vaults

    或者完整路径运行

    $env:OBSIDIAN_API_KEY="your-api-key-here" & "C:\Users\jia'yue\AppData\Roaming\npm\obsidian.cmd" list-vaults

    步骤 5: 配置完成

    测试成功后,更新WorkBuddy配置:

    {
      "api_key": "your-api-key-here",
      "port": 27124,
      "vault_path": "D:\\以观其妙书院知识库\\观其妙书院"
    }
    

    常见问题

    Q: 插件安装失败

    A: 检查网络连接,或手动下载插件文件放到 .obsidian/plugins/obsidian-local-rest-api/

    Q: 连接被拒绝

    A: 检查: 1. Obsidian是否正在运行 2. 插件是否已启用 3. 端口号是否正确 4. 防火墙是否阻止了连接

    Q: API Key无效

    A: 重新生成API Key,确保复制完整

    配置文件参考

    Obsidian CLI配置: C:\Users\jia'yue\.config\obsidian\obsidian.json
    {
      "vaults": {
        "yiguqimiao-main": {
          "path": "D:\\以观其妙书院知识库\\观其妙书院"
        }
      }
    }
    

    下一步

    配置完成后,您可以: 1. ✅ 通过命令行创建Obsidian笔记 2. ✅ 自动同步内容到Obsidian 3. ✅ 在WorkBuddy中直接操作知识库


    配置时间: 2026-04-20 状态: 等待API Key