Swagger UI 总是出现在 NestJS 中

Question

我目前正在学习 NestJS 中的方法。 现在我正在试验 Swagger 功能。 我按照 NestJS 站点上的说明进行操作，并且显示了一个不错的 Swagger 页面。 但是，现在我无法再使用我的控制器路径。

例子：
我有一个路径/api/users将返回用户记录列表。 添加 Swagger 功能后，我在/api上获得了 Swagger UI。 当我尝试请求/api/users我也得到了 swagger UI，这次是空的。
当我单击“用户”API 的“试用”按钮时， /users而不是/api/users将被执行，当然会有 404 响应。

我究竟做错了什么？ 请帮忙。

Answer 1

我假设您已将应用程序的全局前缀设置为/api 。 然后，您还必须相应地设置 swagger 的基本路径。 此外，您应该将 swagger 文档安装到未使用的路径：

// Set the global prefix for all controllers to /api
app.setGlobalPrefix('api');

const document = SwaggerModule.createDocument(
  app,
  new DocumentBuilder()
    // Set the base path for swagger accordingly
    .setBasePath('api')
    .build(),
);

// Choose an unused path to mount your swagger module
SwaggerModule.setup('docs', app, document);
//                  ^^^^^^

Answer 2

我能够通过以下代码实现这一点：

app.setGlobalPrefix("api");

setupSwagger(app);

app.setGlobalPrefix("");

setupSwagger 定义：

export const setupSwagger = (app: INestApplication) => {
  const options = new DocumentBuilder()
    .setTitle(SWAGGER_API_NAME)
    .setDescription(SWAGGER_API_DESCRIPTION)
    .setVersion(SWAGGER_API_CURRENT_VERSION)
    .build();
  const document = SwaggerModule.createDocument(app, options);
  SwaggerModule.setup(SWAGGER_API_ROOT, app, document);
};