Skip to content

全局路径前缀

如果你希望为 HTTP 应用中注册的所有路由统一设置一个前缀,可以使用 INestApplication 实例的 setGlobalPrefix() 方法。

typescript
const app = await NestFactory.create(AppModule);
app.setGlobalPrefix('v1');

你也可以通过以下写法,将某些路由排除在全局前缀之外:

typescript
app.setGlobalPrefix('v1', {
  exclude: [{ path: 'health', method: RequestMethod.GET }],
});

或者,你也可以直接把路由写成字符串形式(此时会匹配所有请求方法):

typescript
app.setGlobalPrefix('v1', { exclude: ['cats'] });

提示

path 属性支持通过 path-to-regexp 包使用通配参数。注意:这里不支持星号 * 通配写法。你必须使用参数形式(:param)或命名通配符形式(*splat)。

基于 NestJS 官方文档翻译