NestJs實現 API 版本管理功能的示例代碼

更新時間：2025年08月18日 09:34:30 作者：Moment

本文主要介紹了NestJS中API版本管理的實現,通過enableVersioning啟用,支持路徑、請求頭等控制方式,確保客戶端兼容性,具有一定的參考價值,感興趣的可以了解一下

基礎配置

在 NestJS 中，版本管理通過 @nestjs/common 提供的 enableVersioning() 方法來啟用。你可以在應用啟動時設置如何管理 API 的版本，NestJS 提供了多種控制版本的方式：路徑、查詢參數、請求頭等。

enableVersioning 是用來啟用 API 版本管理的關鍵方法，它接受一個配置對象。常見的配置方式如下：

import { NestFactory } from "@nestjs/core";
import { AppModule } from "./app.module";
import { VersioningType } from "@nestjs/common";

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  app.enableVersioning({
    type: VersioningType.URI,
    prefix: "v",
  });

  await app.listen(3000);
}
bootstrap();

在上述代碼中，我們啟用了版本管理，并指定了使用路徑作為版本控制的方式，同時版本號將作為路徑的一部分，前綴是 v。這意味著請求 URL 會像 http://localhost:3000/v1/cats 和 http://localhost:3000/v2/cats。

通過控制器和版本實現不同的接口

接下來，我們通過創(chuàng)建不同版本的控制器來管理不同版本的接口。

在 NestJS 中，你可以在控制器中使用 @Controller() 裝飾器的 version 屬性來為每個控制器指定版本號。

import { Controller, Get, Version } from "@nestjs/common";
import { AppService } from "./app.service";

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  @Version("1")
  getHello(): string {
    return this.appService.getHello();
  }

  @Get()
  @Version("2")
  getHi(): string {
    return "this.appService.getHello()";
  }
}

最簡單的方式就是這樣，直接調用 version 的裝飾器，指定版本號，最終結果如下圖所示：

我們也可以直接在 Controller 裝飾器中指定整個路由，如下所示：

import { Controller, Get, Version } from "@nestjs/common";
import { AppService } from "./app.service";

@Controller({
  path: "", // 這里指定了路由路徑
  version: "1", // 這里指定了版本號
})
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }

  @Get()
  getHi(): string {
    return "this.appService.getHello()";
  }
}

這個時候我們訪問 v2 是訪問不到的了，而訪問 v1 是可以訪問的：

和前面的不同，當訪問 URL 時，NestJS 會根據版本號來選擇正確的控制器。

版本控制的不同方式

NestJS 提供了幾種方式來控制 API 的版本，你可以根據實際需求選擇適合的版本控制方式。

最常見的方式是通過 URL 路徑來控制 API 版本。在我們前面的例子中，已經展示了如何通過 v1, v2 等路徑來區(qū)分不同版本的接口。路徑版本控制簡潔明了，適用于大多數場景。

app.enableVersioning({
  type: VersioningType.Query, // 使用查詢參數作為版本控制方式
  defaultVersion: "1", // 默認版本為 v1
});

你還可以通過請求頭中的 Accept 字段來控制版本號。使用這種方式時，客戶端需要在請求中帶上自定義的 Accept 頭來指定版本號。

配置如下：

app.enableVersioning({
  type: VersioningType.Header, // 使用請求頭版本控制
});

客戶端可以在請求中添加自定義的 Accept 頭來指定版本號：

version: 1 訪問 v1 版本。
version: 2 訪問 v2 版本。

此時，API 的版本將通過 Header 參數傳遞。例如：

更多更復雜的控制方式還可以使用 custom，更多用法可以參考官方文檔：

總結

NestJS 提供了非常靈活且強大的 API 版本管理功能，支持通過路徑、查詢參數、請求頭等多種方式來控制 API 的版本。你可以根據實際需求選擇合適的版本控制方式，并通過不同的控制器實現不同版本的 API。同時，合理的版本管理策略能夠確保 API 的穩(wěn)定性和兼容性，避免對現有客戶端造成影響。

到此這篇關于NestJs實現 API 版本管理功能的示例代碼的文章就介紹到這了,更多相關NestJs API 版本管理內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: