yapi-to-code

YApi-to-Code · 接口对接流水线

Auto Mode(无确认模式)

触发:用户输入含任一关键词 → 全跑 / 一气呵成 / auto / yolo / 别问 / 自动,或被 module-flow 委托(auto 透传)。

行为:

• 跳过 Step 3 类型映射预览(强制 showPreview: false,复杂接口也直接写)
• 智能发现接口(Step 1.1)自动选分数 ≥ 7 的全要,不弹候选清单
• validate-define.mjs 失败不阻断(verdict=warn 也继续,落 issues 给上层处理)

保留:

• 文件冲突时仍弹三选(覆盖/重命名/跳过) —— 这是数据安全,不能默认覆盖
• 铁律 1-5 不变

本 skill 读取 .claude/skills/project.config.json 获取项目接口目录/响应壳/HTTP 客户端约定。<config.xxx> 占位指向该配置;Step 0 同时做"现场探测兜底"。

决策树

输入形态
  │
  ├─ 单个/多个 YApi URL                  → Step 1.0 直接解析 projectId+apiId
  ├─ 自然语言("xxx 模块的接口")          → Step 1.1 调 yapi_search_apis 模糊搜
  └─ 仅给项目名                          → Step 1.2 调 yapi_list_projects 列接口让用户选

产出形态
  │
  ├─ 简单接口(< 5字段,无嵌套,无枚举)    → 直接写文件
  ├─ 复杂接口(嵌套≥2/含数组对象/含枚举) → Step 3 给用户预览类型映射后再写
  └─ 多接口批量(CRUD 5 件套)             → 按"查询→新增→修改→删除→详情"排序写

工作流

Step 0 · Reconnaissance(自检 + 探测项目风格)

执行任何步骤前先自检:

1. YApi MCP 可用:调一次 mcp__yapi-auto-mcp__yapi_list_projects 验证。失败立刻告知用户"YApi MCP 未配置"并停止。

2. 读项目配置:config.conventions.responseWrappers / httpClient / httpClientFile / commonTypesFile,以及 config.structure.cacheDir(接口目录)。

3. 配置缺字段时回退到 grep 探测:

   # 项目主流响应壳
   grep -rEho "[A-Z][A-Za-z]*Response<" <config.structure.cacheDir>/ | sort | uniq -c | sort -rn | head -5
   # 项目 HTTP 客户端调用方式
   cat <config.conventions.httpClientFile> | head -20
   

   关注:函数签名、请求体位置、是否强制类型断言、错误返回值。

把探测到的"项目主流响应壳 + HTTP 客户端调用方式 + 接口目录约定"记下,后续 Step 2/4 直接沿用。

Step 1 · 拉接口定义

三种入口分支:

Step 1.0 — 精确路径(已知 projectId + apiId)

mcp__yapi-auto-mcp__yapi_get_api_desc({ projectId, apiId })

返回字段速查:method / path / req_params / req_query / req_body_other / res_body / req_body_is_json_schema。

批量场景:并行调,按业务语义排序(查询/新增/修改/删除/详情)。

Step 1.1 — 智能发现(只给 projectId + 模块语义)

适用:被 module-flow 调度时,只拿到模块语义和 YApi 项目 ID,自动找出该模块需要的接口。

// 1. 从模块语义提关键词组(中英文 + camelCase + kebab-case + 拆词)
const keywords = [semantic, moduleSlug, kebab, ...semantic.split(/\s+/)];

// 2. 并行搜每个关键词
const candidates = await Promise.all(
  keywords.map((kw) =>
    mcp__yapi-auto-mcp__yapi_search_apis({
      projectKeyword: String(projectId),
      nameKeyword: kw,
      limit: 10,
    })
  )
);

// 3. 去重 + 评分 + 给用户候选清单