在 Nest.js 项目中添加 Swagger 基本路径字段

Question

我正在尝试使用 nestjs/swagger 从我的后端创建一个 swagger 文件，但我遇到了与基本路径相关的问题。我想要实现的是将版本显示为基本路径，而不是在所有可用的方法中显示它，这很丑陋且令人困惑。

我的 API 现在具有以下结构（这是 app.module.ts 中存在的一组内容）：

const routes: Routes = [
  {
    path: '/api',
    module: ApiModule,
    children: [
      {
        path: '/v1',
        module: V1Module,
        children: [
          {
            path: '/orders',
            module: OrdersModule
          },
          {
            path: '/users',
            module: UsersModule
          }
        ]
      }
    ]
  }
];

这样，一旦我生成并检查了 swagger，我就会看到我所有的方法都在 /api/v1 前缀之后。这可能是一个例子：

订单

GET   /api/v1/orders
POST  /api/v1/orders
GET   /api/v1/orders/{order_id}
...

用户

GET   /api/v1/users
POST  /api/v1/users
GET   /api/v1/users/{user_id}
...

我想要的是去掉任何方法中出现的/api/v1。我知道 SWAGGER 有 host 和 basePath 字段，但找不到任何方法将其填充到 Nest.js 中。通过研究，我发现有 .setBasePath() 和 .addServer() 方法，但它们对我不起作用（我很确定它们已被弃用）。

非常感谢您的帮助。

Answer 1

如果您希望 nestjs 将 api/v1 添加到每个端点，请使用 setGlobalPrefix('api/v1') 来完成。

https://docs.nestjs.com/faq/global-prefix#global-prefix

在 Nest.js 项目中添加 Swagger 基本路径字段

Add Swagger base path field in Nest.js project

swagger

nestjs

nestjs-swagger