夜猫子的知识栈 夜猫子的知识栈
首页
  • 前端文章

    • JavaScript
  • 学习笔记

    • 《JavaScript教程》
    • 《Web Api》
    • 《ES6教程》
    • 《Vue》
    • 《React》
    • 《TypeScript》
    • 《Git》
    • 《Uniapp》
    • 小程序笔记
    • 《Electron》
    • JS设计模式总结
  • 《前端架构》

    • 《微前端》
    • 《权限控制》
    • monorepo
  • 全栈项目

    • 任务管理日历
    • 无代码平台
    • 图书管理系统
  • HTML
  • CSS
  • Nodejs
  • Midway
  • Nest
  • MySql
  • 其他
  • 技术文档
  • GitHub技巧
  • 博客搭建
  • Ajax
  • Vite
  • Vitest
  • Nuxt
  • UI库文章
  • Docker
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
收藏
  • 分类
  • 标签
  • 归档
GitHub (opens new window)

夜猫子

前端练习生
首页
  • 前端文章

    • JavaScript
  • 学习笔记

    • 《JavaScript教程》
    • 《Web Api》
    • 《ES6教程》
    • 《Vue》
    • 《React》
    • 《TypeScript》
    • 《Git》
    • 《Uniapp》
    • 小程序笔记
    • 《Electron》
    • JS设计模式总结
  • 《前端架构》

    • 《微前端》
    • 《权限控制》
    • monorepo
  • 全栈项目

    • 任务管理日历
    • 无代码平台
    • 图书管理系统
  • HTML
  • CSS
  • Nodejs
  • Midway
  • Nest
  • MySql
  • 其他
  • 技术文档
  • GitHub技巧
  • 博客搭建
  • Ajax
  • Vite
  • Vitest
  • Nuxt
  • UI库文章
  • Docker
  • 学习
  • 面试
  • 心情杂货
  • 实用技巧
  • 友情链接
收藏
  • 分类
  • 标签
  • 归档
GitHub (opens new window)
  • Node基础

  • 《MySQL》学习笔记

  • Midway

  • Nest

    • 开篇词
    • 学习理由
    • nest概念扫盲
    • 快速掌握 nestcli
    • 5种http数据传输方式
    • IoC 解决了什么痛点问题?
    • 如何调试 Nest 项目
    • Provider注入对象
    • 全局模块和生命周期
    • AOP 架构有什么好处?
    • 一网打尽 Nest 全部装饰器
    • Nest如何自定义装饰器
    • Metadata和Reflector
    • ExecutionContext切换上下文
    • Module和Provider的循环依赖处理
    • 如何创建动态模块
    • Nest和Express,fastify
    • Nest的Middleware
    • RxJS和Interceptor
    • 内置Pipe和自定义Pipe
    • ValidationPipe验证post请求参数
    • 如何自定义 Exception Filter
    • 图解串一串 Nest 核心概念
    • 接口如何实现多版本共存
      • 添加路由版本(header添加版本号)
        • 多版本可访问接口
      • accept 中添加版本号
      • URI 中添加版本号
      • 自定义实现版本号的方式
      • 总结
    • Express如何使用multer实现文件上传
    • Nest使用multer实现文件上传
    • 图书管理系统
    • 大文件分片上传
    • 最完美的 OSS 上传方案
    • Nest里如何打印日志
    • 为什么Node里要用Winston打印日志
    • Nest 集成日志框架 Winston
    • 通过Desktop学Docker也太简单了
    • 你的第一个 Dockerfile
  • 其他

  • 服务端
  • Nest
神说要有光
2025-03-10
目录

接口如何实现多版本共存

应用开发完一版上线之后,还会不断的迭代。

后续可能需要修改已有的接口,但是为了兼容,之前版本的接口还要保留。

# 多个版本的接口

那如何同时支持多个版本的接口呢?

Nest 内置了这个功能,我们来试一下:

nest new version-test
1

创建个 nest 项目。

进入项目,创建 aaa 模块:

nest g resource aaa --no-spec
1

把服务跑起来:

npm run start:dev
1

postman 里访问下:

这是版本一的接口。

假设后面我们又开发了一版接口,但路由还是 aaa,怎么做呢?

# 添加路由版本(header添加版本号)

这样:

在 controller 上标记为 version 1,这样默认全部的接口都是 version 1。

然后单独用 @Version 把 version 2 的接口标识一下。

在 main.ts 里调用 enableVersioning 开启接口版本功能:

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

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

  app.enableVersioning({
    type: VersioningType.HEADER,
    header: 'version'
  })
  await app.listen(3000);
}
bootstrap();
1
2
3
4
5
6
7
8
9
10
11
12
13
14

开启接口版本功能,指定通过 version 这个 header 来携带版本号。

测试下:

可以看到,带上 version:1 的 header,访问的就是版本 1 的接口。

带上 version:2 的 header,访问的就是版本 2 的接口。

它们都是同一个路由。

但这时候有个问题:

如果不带版本号就 404 了。

这个也很正常,因为这就是版本一的接口嘛,只有显式声明版本才可以。

# 多版本可访问接口

如果你想所有版本都能访问这个接口,可以用 VERSION_NEUTRAL 这个常量:

现在带不带版本号,不管版本号是几都可以访问这些接口:

但是现在因为从上到下匹配,版本 2 的接口不起作用了:

这时候或者可以把它移到上面去:

或者单独建一个 version 2 的 controller

nest g controller aaa/aaa-v2 --no-spec --flat
1

把 AaaController 里 version 2 的接口删掉,移到这里来:

import { Controller, Get,Version } from '@nestjs/common';
import { AaaService } from './aaa.service';

@Controller({
    path: 'aaa',
    version: '2'
})
export class AaaV2Controller {
    constructor(private readonly aaaService: AaaService) {}

    @Get()
    findAllV2() {
      return this.aaaService.findAll() + '222';
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

现在版本 2 就走的 AaaV2Controller:

其他版本走 AaaController:

一般我们就是这样做的,有一个 Controller 标记为 VERSION_NEUTRAL,其他版本的接口放在单独 Controller 里。

注意,controller 之间同样要注意顺序,前面的 controller 先生效:

试一下:

除了用自定义 header 携带版本号,还有别的方式:

app.enableVersioning({
    type: VersioningType.MEDIA_TYPE,
    key: 'vv='
})
1
2
3
4

# accept 中添加版本号

MEDIA_TYPE 是在 accept 的 header 里携带版本号:

# URI 中添加版本号

你也可以用 URI 的方式:

app.enableVersioning({
    type: VersioningType.URI
})
1
2
3

但是这种方式不支持 VERSION_NEUTRAL,你要指定明确的版本号才可以:

# 自定义实现版本号的方式

此外,如果觉得这些指定版本号的方式都不满足需求,可以自己写:

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

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

  const extractor = (request: Request)=> {
    if(request.headers['disable-custom']) {
      return '';
    }
    return request.url.includes('guang') ? '2' : '1';
  }

  app.enableVersioning({
    type: VersioningType.CUSTOM,
    extractor
  })

  await app.listen(3000);
}

bootstrap();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

我们自己实现了一个版本号的逻辑,如果 url 里包含 guang,就返回版本 2 的接口,否则返回版本 1 的。

此外,如果有 disable-custom 的 header 就返回 404。

试一下:

这样,就能实现各种灵活的版本号规则。

案例代码在小册仓库 (opens new window)。

# 总结

今天我们学了如何开发一个接口的多个版本。

Nest 内置了这个功能,同一个路由,指定不同版本号就可以调用不同的接口。

只要在 main.ts 里调用 enableVersioning 即可。

有 URI、HEADER、MEDIA_TYPE、CUSTOM 四种指定版本号的方式。

HEADER 和 MEDIA_TYPE 都是在 header 里置顶,URI 是在 url 里置顶,而 CUSTOM 是自定义版本号规则。

可以在 @Controller 通过 version 指定版本号,或者在 handler 上通过 @Version 指定版本号。

如果指定为 VERSION_NEUTRAL 则是匹配任何版本号(URI 的方式不支持这个)。

这样,当你需要开发同一个接口的多个版本的时候,就可以用这些内置的功能。

编辑 (opens new window)
上次更新: 2025/5/14 16:47:16
图解串一串 Nest 核心概念
Express如何使用multer实现文件上传

← 图解串一串 Nest 核心概念 Express如何使用multer实现文件上传→

最近更新
01
IoC 解决了什么痛点问题?
03-10
02
如何调试 Nest 项目
03-10
03
Provider注入对象
03-10
更多文章>
Copyright © 2019-2025 Study | MIT License
  • 跟随系统
  • 浅色模式
  • 深色模式
  • 阅读模式