NestJS 在 SwaggerUI 中按字母顺序排列端点

Posted 2023-03-10

【中文标题】NestJS 在 SwaggerUI 中按字母顺序排列端点

【英文标题】：NestJS Alphabetize Endpoints in SwaggerUI

【发布时间】：2021-03-06 12:44:29

【问题描述】：

This SO answer 表明 SwaggerUi 将在实例化时通过 apisSorter : "alpha" 按字母顺序对端点进行排序。在 NestJS 中，配置选项在 SwaggerModule.createDocument 中传递。我看不到配置eg here 的哪个位置可以通过它。

【参考方案1】：

您可以将它作为第四个参数传递给SwaggerModule.setup 方法，如下所示：

const document = SwaggerModule.createDocument(app, options);
  SwaggerModule.setup('docs', app, document, 
    swaggerOptions: 
      tagsSorter: 'alpha',
      operationsSorter: 'alpha',
    ,
  );

swaggerOptions 是untyped，这就是为什么你只需要知道你在传递什么。找到答案in the discord server 所以希望该链接不会过期。

【讨论】：

这行得通，谢谢我见过github.com/nestjs/swagger/blob/…，但不确定这是正确的键...我曾尝试直接传递哈希，这当然没有用