SuperAPI AI 工具集

sync-service-docs

写作与研究

查看项目

更新于 10-16 09:35

技能介绍

用途:为指定服务维护产品文档与代码的同步。调用方式为 /sync-service-docs [service];不传 service 时列出可用服务列表并停止。内置服务配置:ai(OpenAPI 文件 openapi/aitoearn-ai.yaml,源码路径 apps/aitoearn-ai/src/core/,文档目录 docs/ai-service/)、server(openapi/aitoearn-server.yaml,apps/aitoearn-server/src/,docs/server/)。传入的 service 不在配置表中则报错停止。

主要能力与流程:初始化阶段获取 git rev-parse --short HEAD 作为代码基准 hash 与当前日期,检查文档目录是否存在 .md 文件,决定首次建档或差异更新。首次建档时,先读取 OpenAPI 规范,提取 paths、HTTP 方法、operationId、summary,按 tags 分组,每个 tag 生成一个 .md 文件,并提取 parameters、requestBody 与 responses schema;请求/响应结构必须完全来自 OpenAPI,不得猜测字段。随后阅读源码,沿 Controller → Service → Helper/Util → Consumer/Processor → Repository 完整追踪调用链路,被调用的 libs/ 共享库方法也需跟进阅读,按代码实际执行顺序记录参数校验、权限检查、资源查询、数据转换、价格用量计算、异步队列投递与消费、日志记录、外部 API 调用、文件上传等步骤及错误分支。模块数 ≥ 4 或单模块接口数 ≥ 8 时,可用子代理并行处理,每个子代理负责 1-2 个 tag,主流程负责初始化、拆分任务、汇总输出、写文件与生成 README.md。生成的文件标题后紧跟元信息行,记录最后更新时间与代码基准 hash。

差异更新阶段:从已有文档元信息行提取基准 hash,用 git log <doc_hash>..HEAD --oneline -- <openapi_file> <source_path> 判断是否有变更,无输出则跳过;有输出则用 git diff 分析,按变更类型新增、修改或删除对应章节,只更新有实际变化的章节,未变更章节保持原文,最后把变更文档的日期与 hash 更新为当前值。完成后输出变更摘要表(文档、动作、说明)。

文档结构:模块文档包含概述、相关源码路径、接口列表表格(方法、路径、功能),以及每个接口的请求体、响应体和按源码实际顺序排列的业务流程,错误分支写在对应步骤的失败子行。README.md 包含模块索引与通用约定(认证、响应格式、用量记录)。约束:请求/响应结构以 OpenAPI 为准,业务流程来自源码逐行追踪;不得生成测试要点,不单独设计费流程或错误码节,不在模块文档重复通用约定,不猜测字段或流程,不修改未变更章节,不遗漏业务步骤;中文描述,代码标识符保持英文。

适用场景与限制:适用于该仓库中已配置的 ai、server 等服务的文档建档与增量同步,要求本地可访问对应 OpenAPI 文件与源码并具备 git 历史。其他服务需先在配置表中登记;资料中未提供安装方式、收费或其他额外说明。