Loom - 用自然语言生成 API Schema 与文档的 AI Agent

loom chat

自然语言生成 AI API 文档与 Schema

loom view

启动 API 文档与 Schema 查看器

loom mock

启动动态 Mock API 服务做联调

loom serve

文档、Schema 与 Mock 一体化运行

快速开始

几步完成安装，立即开始用 AI 生成 API 文档、Schema 与 Mock 服务

📦 安装

环境要求

Node.js ≥ 18.0.0
npm 或 yarn
DeepSeek API Key（必需）

全局安装

npm install -g @vegamo/loom
# 或
yarn global add @vegamo/loom

⚙️ 配置

配置文件

默认全局配置路径：

macOS/Linux: ~/.loom/config.json
Windows: %APPDATA%/loom/config.json

首次运行 loom chat 时，会以交互向导的形式引导你创建/更新该全局配置文件。

聊天首次引导的默认值：

provider：deepseek
model：deepseek-chat
baseURL：https://api.deepseek.com/v1
apiKey：必填，需由用户输入

你也可以手动创建全局配置：

{
  "outDir": "docs",
  "llm": {
    "provider": "deepseek",
    "model": "deepseek-chat",
    "baseURL": "https://api.deepseek.com/v1",
    "apiKey": "your_deepseek_api_key",
    "temperature": 0.7,
    "maxTokens": 2000
  },
  "serve": {
    "port": 3000,
    "host": "0.0.0.0"
  },
  "mock": {
    "port": 3001,
    "host": "0.0.0.0"
  }
}

docs/ 目录仍保留在各项目目录中（通过 --dir 指定），不会被移动到全局存储。

常见问题

围绕 AI 文档生成、配置、升级、扫描与本地 API 联调的高频问题

Loom 使用全局配置文件，默认路径为 macOS/Linux 的 ~/.loom/config.json 与 Windows 的 %APPDATA%/loom/config.json，也可通过 LOOM_CONFIG 指定自定义路径。配置完成后，AI 文档生成、API Schema 建模与 Mock 服务能力都会复用同一套设置。

首次执行 loom chat 时会进入引导流程，帮助你创建或更新全局配置；其中 apiKey 为必填项，其他参数可先使用默认值再按需调整。完成后即可开始用 AI 生成 API 文档、JSON Schema 与接口说明。

当前 README 中明确支持通过 LLM provider 生成和更新文档，默认引导以 DeepSeek 为例，同时也可使用 OpenAI 等 provider（按配置切换）。你可以按团队偏好选择模型，用于 AI API 文档生成、Schema 设计与接口迭代。

可以。在 loom chat 中可直接使用 /mock、/view 及其 stop/restart 子命令控制 mock server 与文档查看器，减少来回切换。这样在编写 AI 生成的 API 文档时，也能同步验证接口返回与页面展示。

支持。启动时 Loom 会检查 npm 是否有新版本；你可以确认后自动升级，也可以手动执行 loom upgrade。保持版本更新有助于获得更稳定的 AI 文档生成体验与最新的 Schema 能力。

可以。你可以在聊天中使用 /scan <dir> 触发扫描，并通过 /scan resume、/scan reset 管理扫描进度。Loom 会把现有接口信息整理为更易维护的 API 文档、Schema 与实体定义，方便后续继续用 AI 迭代。

Loom — 面向 API Schema 的 AI 文档引擎

AI 驱动 Schema 生成

实体优先的复用建模