SuperAPI AI 工具集

api-doc-checker

编程与开发

查看项目

更新于 10-16 03:11

技能介绍

用途:检查 OpenHarmony API 文档与开发指南的质量,覆盖 7 大质量维度,并可将 API 文档与 interface_sdk-js 仓库中的 .d.ts 定义做一致性校验。

主要能力:按 references/index.json 加载规则模块,解析文档结构(代码块、表格、链接、标题、方法签名等)后执行检查。规则模块包括 spelling、syntax、path-consistency、semantics、project-structure、findability、completeness、correctness、clarity、capability。API 文档执行全部 10 个规则模块;开发指南执行 spelling、syntax、path-consistency、clarity、semantics、project-structure、findability、correctness,completeness 与 capability 可选,不执行 SDK 源码一致性检查。SDK 一致性检查含 10 个检查点,如 api-since-version-match、param-count-match、param-name-match、param-type-match、return-type-match、systemapi-mark-match、stagemodelonly-mark-match、error-code-match、enum-values-complete、interface-fields-complete。

使用方式:先判断文档类型(API 文档文件名匹配 js-apis-.md、capi-.md 等;开发指南含 guide、tutorial、overview、getting-started 等关键词),再加载规则、解析文档、执行检查、生成报告。报告为 Excel(.xlsx),含文件名、Designer、问题类型、问题行号、问题原因、建议修改方案、问题严重级别,支持筛选、排序与条件格式;可选生成 Markdown 汇总。SDK 源码可通过环境变量 INTERFACE_SDK_JS_PATH 指定本地路径,或临时 git clone 后自动清理:export INTERFACE_SDK_JS_PATH=/path/to/interface_sdk-js。

限制:SDK 源码一致性检查仅适用于 API 文档;开发指南不适用。规则存于 references/ 目录 JSON 文件,新增或修改规则无需改 SKILL.md。具体安装命令、收费与平台支持暂未提供。