用途:维护和更新明道云 HAP 的 OpenAPI 3.0 接口文档,适用于新增、修改、删除接口,以及同步中英文版本文档。支持组织授权 API(en/zh-Hans)和应用 API(application)两类文档。
主要能力:按模块创建或修改 paths 与 schemas 文件,更新 openapi.yaml 路由,处理鉴权参数(appKey、sign、timestamp、projectId),并保持中英文结构一致、仅翻译描述性文本。
使用方式:先确定接口类型与模块,收集路径、摘要、参数、响应等信息;为 en 与 zh-Hans 分别创建 paths/{module}/{operationName}.yaml 和 schemas 文件,并在 openapi.yaml 的 paths 中登记路由。修改时用 Grep 定位文件并同步双语版本;删除时移除路由与相关文件并检查引用。完成后可用 VS Code Live Server 打开 index.html 预览 Redoc 渲染效果。
限制:资料未提供安装命令、收费与价格信息;具体模板与示例需查看技能内 references 目录。