OpenAPI Sync Until Valid

精选按需触发

代码质量最多 8 轮

关于 OpenAPI Sync Until Valid

该循环用于让 openapi.yaml 与实际实现的路由保持一致。每一轮先运行 Redocly 检查，再根据报错和路由代码修改规范文件，最多重复 8 轮，需手动触发。

主要功能

01以 Redocly lint 的退出码作为判定依据
02每轮对照已实现的路由修正规范
03最多 8 轮，避免无限重试
04手动触发，由使用者决定何时开始

适用场景

01新增或修改接口后同步 OpenAPI 文档
02合并前清理规范文件中的 lint 报错
03排查文档与实际路由不一致的问题

目标: openapi.yaml 通过 lint 且无报错，并与已实现的路由一致。
退出条件: npx @redocly/cli lint openapi.yaml 以退出码 0 结束时停止，达到 8 轮也会停止。
每轮之间运行: npx @redocly/cli lint openapi.yaml

启动提示词

在 Cursor 中粘贴运行，Agent 会按下面的步骤循环执行，直到满足退出条件。

prompt.md

开始运行“OpenAPI Sync Until Valid”循环。
目标：openapi.yaml 通过 lint 且无报错，并与已实现的路由一致。
最大轮数：8。
第 1 步：运行 lint — 执行 Redocly 检查，收集 openapi.yaml 中的全部报错和警告。若退出码为 0，则循环结束。 `npx @redocly/cli lint openapi.yaml`
第 2 步：对照路由 — 阅读已实现的路由代码，找出规范中缺失、多余或与实现不符的路径、参数和响应。
第 3 步：修改规范 — 按报错和路由差异编辑 openapi.yaml，每次只做必要的改动，然后进入下一轮重新检查。
每轮之间运行：`npx @redocly/cli lint openapi.yaml`
退出条件：npx @redocly/cli lint openapi.yaml 以退出码 0 结束时停止，达到 8 轮也会停止。

步骤

每一轮按顺序执行；未满足退出条件会进入下一轮，最多重复 8 轮。

运行 lint

执行 Redocly 检查，收集 openapi.yaml 中的全部报错和警告。若退出码为 0，则循环结束。

$npx @redocly/cli lint openapi.yaml

对照路由

阅读已实现的路由代码，找出规范中缺失、多余或与实现不符的路径、参数和响应。

修改规范

按报错和路由差异编辑 openapi.yaml，每次只做必要的改动，然后进入下一轮重新检查。

未通过 → 下一轮满足条件即退出

支持的 Agent

可以直接运行这个 Loop 的编码 Agent。

Cursor

支持 Markdown

登录后评论