Obsidian Local REST API 使用教程

1. 项目介绍

Obsidian Local REST API 是一个为 Obsidian 笔记应用提供的插件，它允许用户通过 REST API 与 Obsidian 中的笔记进行交互。这个插件的主要目的是帮助用户自动化与笔记相关的任务，例如创建、更新、删除笔记，以及执行 Obsidian 中的命令。通过这个插件，用户可以轻松地将 Obsidian 与其他工具集成，实现更高效的工作流程。

2. 项目快速启动

2.1 安装插件

首先，确保你已经安装了 Obsidian 应用。然后按照以下步骤安装 Obsidian Local REST API 插件：

1. 打开 Obsidian 应用。
2. 进入“设置” -> “社区插件”。
3. 在“社区插件”页面中，点击“浏览”按钮。
4. 搜索“Local REST API”插件，并点击“安装”。
5. 安装完成后，点击“启用”按钮。

2.2 配置插件

安装完成后，你需要配置插件以生成 API 密钥：

1. 进入“设置” -> “Local REST API”。
2. 点击“生成新的 API 密钥”。
3. 保存生成的 API 密钥，以便后续使用。

2.3 使用 API

以下是一个简单的示例，展示如何使用 API 创建一个新的笔记：

curl -X POST "http://localhost:4567/notes" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "title": "My New Note",
  "content": "This is the content of my new note."
}'

3. 应用案例和最佳实践

3.1 自动化笔记创建

你可以使用 Obsidian Local REST API 来自动化笔记的创建过程。例如，你可以编写一个脚本，定期从外部数据源获取信息，并自动生成笔记。

3.2 与浏览器扩展集成

通过与浏览器扩展（如 Obsidian Web）集成，你可以直接从浏览器中保存网页内容到 Obsidian 笔记中。

3.3 定时任务

你可以设置定时任务，定期执行某些笔记操作，例如备份笔记、更新笔记内容等。

4. 典型生态项目

4.1 Obsidian Web

Obsidian Web 是一个浏览器扩展，它允许用户直接从浏览器中保存网页内容到 Obsidian 笔记中。通过与 Obsidian Local REST API 结合使用，你可以实现更高效的网页内容保存流程。

4.2 Obsidian Advanced URI

Obsidian Advanced URI 是一个插件，它扩展了 Obsidian 的 URL 方案，允许用户通过自定义 URL 执行特定的 Obsidian 命令。结合 Obsidian Local REST API，你可以进一步扩展这些功能，实现更复杂的自动化任务。

通过以上步骤和示例，你可以快速上手并充分利用 Obsidian Local REST API 的功能，提升你的笔记管理和自动化能力。