OpenAPI Sync Until Valid

おすすめ手動実行

OpenAPI Sync Until Valid について

openapi.yaml を、実際に実装されたルートと合わせ続けるためのループです。各ラウンドで Redocly の lint を実行し、エラーとルートのコードをもとに仕様ファイルを修正します。手動で開始し、最大 8 ラウンドまで繰り返します。

主な機能

01Redocly 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 に貼り付けて実行すると、終了条件を満たすまでエージェントが以下の手順を繰り返します。

prompt.md

「OpenAPI Sync Until Valid」ループを開始します。
目標：openapi.yaml が lint でエラーなく通り、実装済みのルートと一致していることです。
最大ラウンド数：8。
ステップ 1：lint を実行 — Redocly の lint を実行し、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 の lint を実行し、openapi.yaml に対するエラーと警告をすべて集めます。終了コードが 0 ならループは終わりです。

$npx @redocly/cli lint openapi.yaml

ルートと照合

実装済みのルートのコードを読み、仕様に不足・余分・不一致があるパス、パラメーター、レスポンスを見つけます。

仕様を修正

報告されたエラーとルートとの差分に合わせて openapi.yaml を最小限の変更で修正し、次のラウンドで再確認します。

未達 → 次のラウンド条件を満たせば終了

対応エージェント

この Loop をそのまま実行できるコーディングエージェントです。

Cursor

Markdown 対応

ログインしてコメント