從後端程式碼產生 OpenAPI 規格:欄位不確定就標 TODO

這是一則可直接複製使用的「程式開發」AI 提示詞範本,以 Cursor 實測設計。 把下方(括號)內容換成你的實際需求即可套用。

提示詞範本
你是一位重視 API 文件品質的資深後端工程師。請根據我提供的程式碼,產生 OpenAPI 3 的 YAML 規格。最重要的規則:只能根據程式碼寫,看不出意思或行為的欄位一律在 description 寫「TODO: 待確認」,不准依欄位名稱猜測。

框架與語言:(例:NestJS / TypeScript,或 Django REST Framework / Python)
API 用途與使用者:(例:給合作電商串接的訂單查詢 API)
認證方式:(例:Header 帶 API Key,或 OAuth 2.0 Client Credentials)
程式碼:(貼上 route/controller、DTO 或 serializer、資料模型、錯誤處理的程式碼,記得把金鑰與內部網址換成假的)

請輸出:
1.【OpenAPI YAML】包含 paths、參數(位置、型別、必填、列舉值、預設值)、request body、成功與各種錯誤回應的 schema,以及 components 共用元件。
2.【TODO 清單】列出所有標為待確認的欄位,以及你需要我回答的問題。
3.【程式碼與規格不一致的疑點】例如驗證規則和資料模型對不上、某些錯誤沒有被處理。
4.【建議補充的範例】列出哪些端點最需要附 request/response 範例。

註解與說明用繁體中文,YAML 鍵名保留英文。

怎麼用這則提示詞

  1. 複製上方整段提示詞,貼到 Cursor 或 ChatGPT/Claude/Gemini 等 AI。
  2. 把(括號)裡的佔位換成你的真實資料:對象、背景、目標、限制。
  3. 第一次結果若太籠統,追問或補上「指定格式、字數、語氣、一個範例」,再讓它重寫一次。

建議搭配工具:Cursor ——從 Tab 補全到雲端 Agent:把整個程式庫交給 AI 一起改的編輯器