在現代API開發中,實現API版本控制是不可或缺的設計模式,特別是當應用逐步擴展且不斷迭代時,良好的版本管理至關重要。本文將介紹如何在NestJS中使用 VersioningType.URI
來實現API的版本控制,並深入分析兩種控制器的版本設定方式,幫助開發者根據實際需求選擇最佳方案。
Step 1: 設定全域前綴詞(setGlobalPrefix)
首先,設定全域前綴詞是必要的。務必先設定 setGlobalPrefix
,再啟用版本控制,否則後續的版本控制將無法正確應用到API路徑。
// 設置全域的API前綴詞
const globalPrefix = 'api';
app.setGlobalPrefix(globalPrefix);
這行代碼會將所有API路徑統一設為/api
開頭,例如/api/v1/test/echo
。這樣可以讓API結構層次分明,並方便後續的維護和版本管理。