REST API 設計速查 - 免費線上開發工具

← ToolBox / REST API 設計速查

🌐 REST API Design Quick Reference

📐 工作原理與說明

RESTful API 設計要點速查。

資源：用名詞複數表示資源集合，用 HTTP 方法表達動作，而非在 URL 中寫動詞。
狀態碼：200 成功、201 建立、204 無內容、400 引數錯誤、401 未認證、403 無許可權、404 不存在、409 衝突、500 服務端錯誤。
查詢：分頁、過濾與排序通過查詢引數傳遞，如 ?page=1&size=20&sort=-createdAt。
原則：介面無狀態，每次請求攜帶完整上下文；版本化可用 URL 字首或請求頭。

Browse a REST API cheat sheet in your browser — methods, status codes and best practices.

📚 深度解析：REST API 設計速查

💡 常見使用場景

資源命名/狀態碼/版本規範。
評審介面設計時對照規範：確認資源名用複數、狀態碼語義正確、分頁與錯誤格式統一，減少後續返工。

命名

用複數名詞 `/users/{id}`，GET 查、POST 建、PATCH 改。

❓ 常見問題（FAQ）

409 與 400 區別？: 400 請求格式錯，409 衝突（如重複建立）。
版本該放在 URL 還是請求頭？: 兩種都有實踐：URL 路徑（/v1/users）最直觀、便於快取與除錯，是最常見選擇；請求頭（Accept: application/vnd.api+json;version=1）保持 URL 乾淨，但不易在瀏覽器裡直接測試。選擇後應保持一致，並明確廢棄策略——提前公告、並行執行一段時間再下線。

⚠️ 使用說明與注意事項

本工具純前端執行，資料不會上傳到伺服器
建議在主流瀏覽器（Chrome/Safari/Firefox/Edge）中使用
計算結果僅供參考，請以實際應用場景為準

已複製

📖關於「REST API 設計速查」 ▼

📝工具簡介

REST API 設計速查。專為開發者打造的線上工具，純前端執行，程式碼不離開瀏覽器。