在新建立的 sprint 分支中,預設沒有任何內容。這種方式可協助開發人員專注於目前 sprint 所需的變更。你可以使用兩種主要方法新增資源並進行修改。選擇你的方法#
| 方法 | 最適合 | 主要優點 |
|---|
| 手動變更 | API-First 開發 | 開發前具備清楚的規格 |
| OAS 匯入 | Code-First 開發 | 自動與主分支比較 |
Apidog 強烈建議採用 API-First 方法(手動變更),以提升效率並降低協作成本。
手動變更#
在 sprint 分支中手動修改內容,可讓你在投入開發前清楚定義 API 規格。從主分支 Fork 資源#
當你需要根據目前 sprint 需求修改現有端點、結構描述或回應元件時:1.
使用 Fork from main 建立所需資源的副本
端點案例預 設會隨端點一起匯入,並且也會顯示關聯指示器。從主分支拉取最新變更#
在 sprint 分支中工作時,緊急更新可能需要直接在主分支中進行變更。若要同步:3.
選擇是否拉取更新,或保留目前 sprint 分支內容
建立新資源#
若要為目前 sprint 建立新的端點、結構描述或回應元件:1.
使用 New 功能將資源新增至目前 sprint 分支
2.
Select Endpoint Folders:選擇現有資料夾
New Endpoint Folder:建立新資料夾
重新排序與調整資料夾內容#
你可以對匯入或新建立的資源執行與主分支中相同的操作:刪除與還原資源#
Sprint 分支具備垃圾桶功能,其運作方式與主分支相同:反覆匯入、刪除並還原同一個主分支資源,可能導致非預期的資料問題。請盡量減少這些操作,以維持資料完整性。
模擬、比較與協作#
Sprint 分支中的端點具有該分支專屬的唯一模擬位址,完全依賴目前 sprint 分支的端點定義。將 sprint 分支資源與主分支中的對應資源進行比較,以識別具體差異。透過協作連結與其他專案成員分享 sprint 分支端點。當你在其他分支中點擊 sprint 分支端點協作連結時, 系統會提示你切換分支。切換前,請先儲存目前分支中的任何變更。
OAS 匯入#
使用手動、排程或 API 匯入方法,將 OpenAPI Specification (OAS) 檔案直接匯入 sprint 分支。將 OAS 匯入 Sprint 分支#
2.
前往 Project Settings → Import Data
自動與主分支比較#
將 OAS 匯入 sprint 分支時,處理邏輯如下:1.
將 OAS 檔案中每個端點的「Path & Method」與主分支進行比較
4.
如果是新的:會在 sprint 分支中建立新的結構描述
成功匯入後,你會看到新增至 sprint 分支的新資源與已修改資源概覽。與主分支相比完全沒有變更的資源,在匯入後不會包含於 sprint 分支中,協助開發人員專注於必要變更。