NestJs实现 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();

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()";
  }
}

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()";
  }
}

app.enableVersioning({
  type: VersioningType.Query, // 使用查询参数作为版本控制方式
  defaultVersion: "1", // 默认版本为 v1
});

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

version: 1 访问 v1 版本。
version: 2 访问 v2 版本。