API & Endpoint
API 與端點
API 是軟體彼此溝通的一套規則；端點則是 API 裡的一個位址和一項操作。
另一個例子
應用程式呼叫 GET /api/projects，並依 API 文件指定的回應格式取得專案資料。
主要部分
- 01來源請求
- 02解析或處理節點
- 03回應、時間與失敗狀態
什麼時候用
API 契約應清楚寫出方法、資料格式規則（Schema）、錯誤、權限和版本。
什麼時候不要用
不要暴露內部資料庫結構，也不要公開可能改變的實作細節。
程式裡的名稱
HTTP method + route + schema 上線前要檢查
檢查介面約定、任何情況都不能破壞的規則、授權與輸入限制。測試重試、重複執行只生效一次、逾時與部分失敗。驗證資料完整性、相容性、監控、復原與回復上一版。
預期成果：為這套系統設計或檢查 API 與端點 (API & Endpoint)，並讓資料保持正確、安全且容易維護。 使用者情境：應用程式呼叫 GET /api/projects，並依 API 文件指定的回應格式取得專案資料。 技術概念或控制措施：API 與端點 (API & Endpoint)。 適用理由：API 契約應清楚寫出方法、資料格式規則（Schema）、錯誤、權限和版本。 不應使用的情況：不要暴露內部資料庫結構，也不要公開可能改變的實作細節。 工程要求：定義輸入、輸出、介面約定，以及任何情況都不能破壞的規則。說明授權與輸入檢查範圍。定義失敗、逾時、重試和重複執行只生效一次的規則。也要定義資料搬移與相容限制。 營運要求：加入監控訊號與隱藏敏感資料的記錄。設定容量上限並寫好操作手冊。測試復原與回復上一版的流程。 驗收條件：介面約定與失敗路徑測試通過。重試或部分失敗時，資料與授權規則仍正確。效能上限、監控、復原與回復上一版的方法都已驗證。 證據與限制（證據邊界）：沒有一份官方標準能管到全部內容。不同團隊、平台或框架的用法可能不同。 待確認：程式執行環境、資料位置、流量形態、資料一致需求和安全邊界。也要確認相容期間、服務目標（SLO）與回復上一版的限制。
檢查這份需求
請 AI 程式助手檢查目前如何使用 API 與端點 (API & Endpoint)。 定義：API 是軟體彼此溝通的一套規則；端點則是 API 裡的一個位址和一項操作。 正式環境檢查：檢查介面約定、任何情況都不能破壞的規則、授權與輸入限制。測試重試、重複執行只生效一次、逾時與部分失敗。驗證資料完整性、相容性、監控、復原與回復上一版。 修改程式前，先列出看到的證據、缺口、嚴重程度，以及最小且安全的修正。