javascript - Swagger UI 总是出现在 NestJS 中

Question

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

示例:
我有一个路径 /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);
//                  ^^^^^^