NestJS实现接口的多版本管理

 更新时间:2024年06月13日 08:42:44   作者:云牧  
在软件开发中,随着应用的迭代更新,经常需要引入新的接口版本同时保留旧版本以保证向后兼容,本教程将通过 NestJS 框架演示如何实现接口的多版本管理,感兴趣的小伙伴跟着小编一起来看看吧

创建和运行项目

首先,我们需要创建一个新的 NestJS 项目,并启动服务:

nest new version-test -p pnpm
cd version-test
nest g resource TestVersion --no-spec
pnpm start:dev

启用接口版本控制

在 main.ts 文件中,引入版本控制功能,并设置版本信息通过 HTTP 头部传递:

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

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

  app.enableVersioning({
    type: VersioningType.HEADER,
    header: 'version', // 指定传递版本信息的 HTTP 头部字段名为 'version'
  });

  await app.listen(3000);
}

bootstrap();

配置版本控制

在控制器中,我们可以通过 @Version 装饰器指定接口版本。

例如,将默认接口设置为版本 1,并为新版本创建专门的接口:

import { Controller, Get, Version } from '@nestjs/common';
import { TestVersionService } from './test-version.service';

@Controller('test-version')
export class TestVersionController {
  constructor(private readonly testVersionService: TestVersionService) {}

  @Get()
  @Version('1')
  findAllV1() {
    return this.testVersionService.findAll();
  }

  @Get()
  @Version('2')
  findAllV2() {
    return this.testVersionService.findAll() + '版本2';
  }
}

带上不同的请求头,获得的结果不一样。

版本中立的接口

如果希望某些接口无论什么版本号如何都能访问,可以使用 VERSION_NEUTRAL 常量:

import { VERSION_NEUTRAL, Controller, Get } from '@nestjs/common';

@Controller({
  path: 'test-version',
  version: VERSION_NEUTRAL
})
export class NeutralAaaController {
  // 接口实现
}

其他版本控制方式

NestJS 还支持通过媒体类型(Media Type)或 URI 路径来控制版本:

Media Type

版本信息通过 Accept 头部传递:

app.enableVersioning({
    type: VersioningType.MEDIA_TYPE,
    key: 'vvv='
})

如果客户端希望请求版本 1 的 API,它需要在 HTTP 请求的 Accept 头部中加入如下内容:

Accept: application/json;vvv=1

URI 版本控制

版本信息直接在 URL 路径中指定:

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

在这个设置下,如果客户端需要访问版本 1 的 API,URL 应该像这样:

http://localhost:3000/v1/users

对于版本 2,URL 应该是:

http://localhost:3000/v2/users

这种方式使得版本控制非常明显,客户端一看 URL 就能明白所请求的 API 版本。但可能会导致 URL 空间的膨胀。
注意这种方式不支持 VERSION_NEUTRAL,需要明确版本号:

@Controller({
  path: 'test-version',
  version: ["2", "3"]
})

自定义版本控制逻辑

如果内置的版本控制方式不满足需求,可以实现自定义版本控制逻辑:

import { VersioningType, NestFactory } from '@nestjs/common';
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('yun') ? '2' : '1';
  };
  app.enableVersioning({
    type: VersioningType.CUSTOM,
    extractor
  });
  await app.listen(3000);
}

bootstrap();

以上就是NestJS实现接口的多版本管理的详细内容,更多关于NestJS接口管理的资料请关注脚本之家其它相关文章!

相关文章

  • Node.js 文件夹目录结构创建实例代码

    Node.js 文件夹目录结构创建实例代码

    下面小编就为大家带来一篇Node.js 文件夹目录结构创建实例代码。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-07-07
  • nodejs代码执行绕过的一些技巧汇总

    nodejs代码执行绕过的一些技巧汇总

    这篇文章主要给大家介绍了关于nodejs代码执行绕过的一些技巧,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-04-04
  • 一文教会你从Windows中完全删除node.js

    一文教会你从Windows中完全删除node.js

    作为新手nodejs卸载后安装就总出错,下面这篇文章主要给大家介绍了关于如何从Windows中完全删除node.js的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-08-08
  • Nodejs中Express框架的基本使用举例

    Nodejs中Express框架的基本使用举例

    Express是基于Node.js平台的极简、灵活的Web应用开发框架,它为 Node.js提供了一套强大的功能,用于创建Web应用程序和 HTTP 服务器,下面我们将介绍Nodejs中Express框架的基本使用,感兴趣的朋友一起看看吧
    2025-09-09
  • nodejs爬虫抓取数据乱码问题总结

    nodejs爬虫抓取数据乱码问题总结

    这篇文章主要给大家总结了下nodejs爬虫抓取数据乱码问题的相关资料,需要的朋友可以参考下
    2015-07-07
  • nodejs中使用HTTP分块响应和定时器示例代码

    nodejs中使用HTTP分块响应和定时器示例代码

    本文通过示例将要创建一个输出纯文本的HTTP服务器,输出的纯文本每隔一秒会新增100个用换行符分隔的时间戳。实例代码非常不错,具有参考借鉴价值,需要的朋友参考下
    2017-03-03
  • Public Npm Registry模块使用方式实例

    Public Npm Registry模块使用方式实例

    这篇文章主要为大家介绍了Public Npm Registry的使用方式示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-11-11
  • Node.JS用纯JavaScript生成图片或滑块式验证码功能

    Node.JS用纯JavaScript生成图片或滑块式验证码功能

    有一些Node.JS图片生成类库,比如node-captcha等的类库,需要c/c++程序生成图片。跨平台部署不是很方便。这里介绍几个用纯JS实现的图片验证码生成模块,需要的朋友可以参考下
    2019-09-09
  • 基于node.js依赖express解析post请求四种数据格式

    基于node.js依赖express解析post请求四种数据格式

    本篇文章主要介绍了node.js依赖express解析post请求四种数据格式,主要是www-form-urlencoded,form-data,application/json,text/xml,有兴趣的可以了解一下。
    2017-02-02
  • node实现shell命令管理工具及commander.js学习

    node实现shell命令管理工具及commander.js学习

    这篇文章主要为大家介绍了node实现shell命令管理工具及commander.js学习,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-09-09

最新评论