Obsidian API 入门

Obsidian 插件通过 obsidian 包暴露的 API 与宿主交互。本文概览最常用的 API 面，帮你建立心智模型。

核心要点

概览 API 面

• App：全局对象 this.app，提供 vault（仓库）、workspace（工作区）、metadataCache（元数据缓存）
• Plugin：你的插件基类，提供 addCommand / addRibbonIcon / registerView 等注册方法
• Vault API：读写文件、监听变更（app.vault.read / create / modify / on("create")）
• Workspace API：操作面板、叶子（Leaf）、布局（app.workspace.getLeaf / getRightLeaf）
• Modal / Setting / Notice：UI 构件，分别做弹窗、设置项、轻提示

典型调用

import { Plugin } from "obsidian";

export default class MyPlugin extends Plugin {
  async onload() {
    this.addCommand({
      id: "hello",
      name: "打招呼",
      callback: () => new Notice("你好，Obsidian！"),
    });
  }
}

获取类型提示

• 安装 obsidian 类型包（开发依赖），TS 即可获得完整补全
• 用 this.app 的类型推断定位可用方法

相关阅读

• 开发入门分区
• 插件结构
• File API 指南