REST API 端點設計指令

黃黃柏睿・技術編輯 ·被複製 420 次·最後更新 2026/06/09

適用模型ClaudeChatGPT

一句話結論快速產出符合 RESTful 規範的 API 設計文件與介面定義。

指令介紹

API 設計混亂是前後端合作最大摩擦來源之一。這組指令會依你的資源定義與業務需求，產出完整的 REST API 設計，包含端點命名、HTTP 方法、請求與回應結構、錯誤碼規範以及版本控制建議，讓前後端有共同語言、減少溝通成本。無論是新專案設計或舊 API 重構，都能快速產出標準草稿。

適用情境

新專案 API 設計前後端介面定義API 文件草稿API 重構規劃

懶人貼上・複製就能用

已填好範例複製就能直接用

帶去 Claude 帶去 ChatGPT

▸ 想換成你自己的內容？點開填一填選填

API 資源名稱

核心操作

認證方式

⬇ 匯出此指令 CSV

AI 指令庫編輯的話

編輯實測指令涵蓋「端點加Schema加錯誤碼加版本加安全」，API 設計一次完成不遺漏。這組「REST API 端點設計指令」是 Prompts 編輯團隊實測整理的程式 AI 指令（Prompt），適合用 Claude、ChatGPT 執行。複製上方指令範本即可使用，免費、免註冊。

模型實測對照

產出 GET /articles（分頁）、POST /articles、GET /articles/{id}、PUT /articles/{id}、DELETE /articles/{id} 完整設計，含 OpenAPI 風格 Schema、400/401/403/404/422 錯誤碼定義、URL 版本控制（/v1/）建議與 JWT 驗證注意事項（過期刷新、權限層級）。

實測（Claude）：端點加 Schema 加錯誤碼加版本控制加安全，最標準完整。

產出 RESTful API 設計含端點清單與 JSON 結構。

實測（ChatGPT）：快速可用，適合快速溝通草稿。