使用 @nestjs/swagger 时如何设置 Swagger UI 选项（例如：displayOperationId=true）答案

【问题标题】：How to set Swagger UI options when using @nestjs/swagger (ex: displayOperationId=true)使用 @nestjs/swagger 时如何设置 Swagger UI 选项（例如：displayOperationId=true）
【发布时间】：2021-10-09 06:44:39
【问题描述】：

我可以通过将配置放在 url 中来启用显示每个端点的 opperationId： http://localhost:3000/api?displayOperationId=true

但是，我希望将此作为默认行为。在nestjs的设置过程中如何为swagger-ui设置配置变量SwaggerModule

【问题讨论】：

标签： swagger config nestjs swagger-ui

【解决方案1】：

是的，你可以！

解决方案是基于你的 HTTP 适配器，但是创建是一样的：

创作：

const config = new DocumentBuilder()
    .setTitle('title')
    .setDescription('desc')
    .setVersion('1.0')
    .build();

const document = SwaggerModule.createDocument(app, config);

快递：

如果您使用 Express（这是默认适配器）作为适配器

你需要通过displayOperationId: true中的swaggerOptions

像这样：

SwaggerModule.setup('docs', app, document, {
    swaggerOptions: {
      displayOperationId: true,
    },
});

对于 Fastify：

如果你使用 Fastify 作为适配器

你需要通过displayOperationId: true中的uiConfig

像这样：

SwaggerModule.setup('/docs', app, document, {
  uiConfig:  {
    displayOperationId: true,
  }
});

【讨论】：