一个写接口文档的AI Agent。支持使用Vibe coding 的方式,编写接口文档,同时自带友好的文档查看工具与接口Mock工具
1.0k
Stars
25
Forks
1
Watchers
1
Issues
简体中文 | English
基于 AI 的 JSON Schema 文档生成器,集成 TUI 交互、Web 浏览器与 Mock 服务
docs/entities 中维护可复用的实体 Schema,通过 x-entity-ref 在接口 Schema 中引用/mock、/view)loom manifest rebuild 命令重建依赖/索引一致性npm install -g @vegamo/loom
# 或
yarn global add @vegamo/loom
默认全局配置路径:
~/.loom/config.json%APPDATA%/loom/config.json首次运行 loom chat 时,会以交互向导的形式引导你创建/更新该全局配置文件。
聊天首次引导的默认值:
provider:deepseekmodel:deepseek-chatbaseURL:https://api.deepseek.com/v1apiKey:必填,需由用户输入你也可以手动创建全局配置:
{
"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 指定),不会被移动到全局存储。
# 启动交互式 TUI 来生成 JSON Schema
loom chat
# 或指定项目目录
loom chat --dir ./my-api-project
在 loom chat 中,你也可以控制本地服务:
/mock、/mock stop、/mock restart [port]/view、/view stop、/view restart [port]# 启动 Web 文档浏览器
loom view
# 或指定端口
loom view --port 8080
# 启动 Mock API 服务
loom mock
# 或指定端口
loom mock --port 8081
# 在同一端口同时启动 Viewer 和 Mock 服务
loom serve
# 访问入口:
# - Web Viewer: http://localhost:3000
# - Mock API: http://localhost:3000/mock/...
# 手动触发升级
loom upgrade
执行其它命令时,Loom 也会检查 npm 是否有新版本。
发现新版本时,确认即可自动升级。
loom chat通过 AI 对话生成 JSON Schema 文档的交互式终端 UI。
loom chat [options]
Options:
-d, --dir 目标项目目录(默认:当前目录)
-h, --help 显示帮助
典型流程:
loom chatdocs/ 目录(可配置)内置聊天命令:
Enter 发送,Shift+Enter/Alt+Enter 换行,↑/↓ 浏览历史记录(跨会话持久化),Tab 自动补全命令/help —— 显示命令帮助/reset —— 重置对话历史/list —— 列出已生成的 Schema 文件/mock、/mock stop、/mock restart [port] —— 管理 Mock 服务/view、/view stop、/view restart [port] —— 管理 Web Viewer/scan —— 通过 LLM 从源码中识别 API;/scan resume、/scan reset 管理断点/abort —— 中止当前请求/exit —— 退出 Loomloom view基于 React SPA 的现代化 Web 文档浏览器。
loom view [options]
Options:
-p, --port 端口号(默认:3000)
-d, --dir 目标项目目录(默认:当前目录)
-h, --help 显示帮助
特性:
docs/entities 中的实体x-entity-refloom mock基于 JSON Schema 动态生成数据的 Mock API 服务。
loom mock [options]
Options:
-p, --port 端口号(默认:3001)
-d, --dir 目标项目目录(默认:当前目录)
-h, --help 显示帮助
特性:
loom serve组合服务,同时运行 Web Viewer 与 Mock 服务。
loom serve [options]
Options:
-p, --port 端口号(默认:3000)
-d, --dir 目标项目目录(默认:当前目录)
-h, --help 显示帮助
URL 结构:
http://localhost:3000/ —— Web 文档浏览器http://localhost:3000/api/docs —— 文档 APIhttp://localhost:3000/api/schemas —— Schema 文件 APIhttp://localhost:3000/api/entities —— 实体文件 APIhttp://localhost:3000/mock/... —— Mock API 路由loom manifest rebuild重建文档清单索引文件 .loom-manifest.json,确保依赖/索引一致。
loom manifest rebuild [options]
Options:
-d, --dir 目标项目目录(默认:当前目录)
-h, --help 显示帮助
loom upgrade将 loom 升级到 npm 上的最新版本。
loom upgrade
Loom 使用一套为 API 文档优化的自定义 JSON Schema 格式:
{
"$schema": "http://json-
Loom 是一个基于 AI 驱动的接口文档生成工具,它利用大模型通过对话式终端界面(TUI)自动编写 JSON Schema 文档。该项目通过集成文档查看与 Mock 服务,实现了从定义、管理到验证的全链路接口开发体验,有效解决了 API 文档编写效率低和维护困难的问题。
通过 AI 对话驱动 JSON Schema 的生成与更新,支持在 TUI 中直接进行高效的文档交互。支持实体建模与复用机制,能够通过 x-entity-ref 轻松引用已有的 Schema 定义。内置现代化的 React 文档浏览器,提供直观的接口预览、搜索与解析功能。提供基于 Schema 自动生成的 Mock API 服务,支持多种 HTTP 方法并能灵活配置响应数据。提供一体化的服务控制命令,支持在终端内直接管理文档展示与数据模拟服务的启动与重启。
适用于需要快速构建 API 文档的后端开发人员,特别适合在追求 Vibe coding 效率的敏捷开发环境中使用。该项目也适用于前后端分离场景下,需要即时生成 Mock 数据以进行前端并行开发的团队。