788 B
788 B
API Doc Sync Workflow
该目录集中管理接口文档变更抓取相关的脚本、配置和数据,避免与业务 src 代码混放。
目录说明
config.mjs:工作流配置(抓取地址、文件路径、历史保留数量)。update.mjs:抓取并更新接口变更的主流程脚本。data/changes.json:本地最新接口更新日志(全量)。data/pending-updates.json:待更新接口清单(仅summary、methods、notes)。data/history/:历史快照,自动保留最近 5 份。
运行
npm run update
扩展建议
- 新增工作流功能时,优先在
workflows/api-doc-sync内按模块拆分文件。 - 如果增加新的数据产物,统一放在
data/内并在此文档补充说明。