SuperAPI AI 工具集

dify-docs-api-reference

写作与研究

查看项目

更新于 10-15 23:48

技能介绍

用途:为 Dify 服务 API 的 OpenAPI 规范({en,zh,ja}/api-reference/openapi_service.json)提供编写与审计规则,面向通过 REST 集成 Dify 应用或知识库的后端开发者。核心原则是以代码为准:规范与代码冲突时规范有误,所有细节都须能追溯到 Dify 代码库中的控制器、模型或转换器。

阶段流程:S1 限定范围,从 references/codebase-paths.md 的 AppMode 表确定操作服务的应用类型,后续检查均经该类型视角过滤;S5 按 references/spec-conventions.md 约定编写或编辑 summary、operationId、描述、参数、响应、错误格式、schema、示例、标签与排序;S6 三种语言规范在同一轮直接编辑,parity_check 替代单独翻译步骤;S2/S7 逐项对照代码核验。

结构与校验:每种语言一份规范,共享端点只出现一次,用可用性行与按模式说明覆盖多模式;每个操作需带 x-mint.href 与 x-mint.metadata.title/sidebarTitle。结构改动后需更新 memberships.json 与应用类型总览页,再运行 wire、check-coverage、lint_specs、parity_check;仅描述改动只需 lint。

核验要点:schema 约束须与 Pydantic Field() 参数逐字一致;有无默认值决定必填;状态码、响应字段、错误码与消息须追溯到代码;同一路由名在 web/console 蓝图中可能路径、认证与参数不同,须匹配 base URL 与 servers 的蓝图。S7 还要求独立子代理审计(新增或实质变更端点)与示例/schema 一致性检查。

限制:本规则包不是写作入口,编辑或创建规范由 dify-docs-write 负责;疑似的代码缺陷须显式标记、给出证据并请用户决定,不得自动更正或静默记录。工具的收费、价格与具体命令运行环境暂未提供。