其他功能

本页列出了所有其他可能对你有用的功能特性。

全局前缀

如果需要忽略通过 setGlobalPrefix() 设置的全局路由前缀，可以使用 ignoreGlobalPrefix 选项：

const document = SwaggerModule.createDocument(app, options, {
  ignoreGlobalPrefix: true,
});

全局参数

你可以使用 DocumentBuilder 为所有路由定义全局参数，如下所示：

const config = new DocumentBuilder()
  .addGlobalParameters({
    name: 'tenantId',
    in: 'header',
  })
  // 其他配置
  .build();

全局响应

你可以使用 DocumentBuilder 为所有路由定义全局响应。这在为应用程序中的所有端点设置一致的响应时非常有用，例如 401 Unauthorized 或 500 Internal Server Error 等错误码。

const config = new DocumentBuilder()
  .addGlobalResponse({
    status: 500,
    description: 'Internal server error',
  })
  // 其他配置
  .build();

多规范

SwaggerModule 提供了支持多个规范的方式。换句话说，你可以在不同的端点上提供不同的文档和不同的 UI。

要支持多个规范，应用程序必须采用模块化的方式编写。createDocument() 方法接受第三个参数 extraOptions，它是一个包含 include 属性的对象。include 属性的值是一个模块数组。

你可以按照以下方式设置多规范支持：

import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { AppModule } from './app.module';
import { CatsModule } from './cats/cats.module';
import { DogsModule } from './dogs/dogs.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  /**
   * createDocument(application, configurationOptions, extraOptions);
   *
   * createDocument method takes an optional 3rd argument "extraOptions"
   * which is an object with "include" property where you can pass an Array
   * of Modules that you want to include in that Swagger Specification
   * E.g: CatsModule and DogsModule will have two separate Swagger Specifications which
   * will be exposed on two different SwaggerUI with two different endpoints.
   */

  const options = new DocumentBuilder()
    .setTitle('Cats example')
    .setDescription('The cats API description')
    .setVersion('1.0')
    .addTag('cats')
    .build();

  const catDocumentFactory = () =>
    SwaggerModule.createDocument(app, options, {
      include: [CatsModule],
    });
  SwaggerModule.setup('api/cats', app, catDocumentFactory);

  const secondOptions = new DocumentBuilder()
    .setTitle('Dogs example')
    .setDescription('The dogs API description')
    .setVersion('1.0')
    .addTag('dogs')
    .build();

  const dogDocumentFactory = () =>
    SwaggerModule.createDocument(app, secondOptions, {
      include: [DogsModule],
    });
  SwaggerModule.setup('api/dogs', app, dogDocumentFactory);

  await app.listen(process.env.PORT ?? 3000);
}
bootstrap();

现在你可以使用以下命令启动服务器：

$ npm run start

访问 http://localhost:3000/api/cats 可以看到 cats 的 Swagger UI：

而 http://localhost:3000/api/dogs 则会展示 dogs 的 Swagger UI：

资源管理器栏中的下拉菜单

要在资源管理器栏的下拉菜单中启用多规范支持，你需要设置 explorer: true 并在 SwaggerCustomOptions 中配置 swaggerOptions.urls。

提示

请确保 swaggerOptions.urls 指向 Swagger 文档的 JSON 格式！要指定 JSON 文档，请在 SwaggerCustomOptions 中使用 jsonDocumentUrl。更多设置选项请参阅此处。

以下是如何在资源管理器栏的下拉菜单中设置多个规范：

import { NestFactory } from '@nestjs/core';
import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';
import { AppModule } from './app.module';
import { CatsModule } from './cats/cats.module';
import { DogsModule } from './dogs/dogs.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);

  // Main API options
  const options = new DocumentBuilder()
    .setTitle('Multiple Specifications Example')
    .setDescription('Description for multiple specifications')
    .setVersion('1.0')
    .build();

  // Create main API document
  const document = SwaggerModule.createDocument(app, options);

  // Setup main API Swagger UI with dropdown support
  SwaggerModule.setup('api', app, document, {
    explorer: true,
    swaggerOptions: {
      urls: [
        {
          name: '1. API',
          url: 'api/swagger.json',
        },
        {
          name: '2. Cats API',
          url: 'api/cats/swagger.json',
        },
        {
          name: '3. Dogs API',
          url: 'api/dogs/swagger.json',
        },
      ],
    },
    jsonDocumentUrl: '/api/swagger.json',
  });

  // Cats API options
  const catOptions = new DocumentBuilder()
    .setTitle('Cats Example')
    .setDescription('Description for the Cats API')
    .setVersion('1.0')
    .addTag('cats')
    .build();

  // Create Cats API document
  const catDocument = SwaggerModule.createDocument(app, catOptions, {
    include: [CatsModule],
  });

  // Setup Cats API Swagger UI
  SwaggerModule.setup('api/cats', app, catDocument, {
    jsonDocumentUrl: '/api/cats/swagger.json',
  });

  // Dogs API options
  const dogOptions = new DocumentBuilder()
    .setTitle('Dogs Example')
    .setDescription('Description for the Dogs API')
    .setVersion('1.0')
    .addTag('dogs')
    .build();

  // Create Dogs API document
  const dogDocument = SwaggerModule.createDocument(app, dogOptions, {
    include: [DogsModule],
  });

  // Setup Dogs API Swagger UI
  SwaggerModule.setup('api/dogs', app, dogDocument, {
    jsonDocumentUrl: '/api/dogs/swagger.json',
  });

  await app.listen(3000);
}

bootstrap();

在这个示例中，我们设置了一个主 API 以及 Cats 和 Dogs 的独立规范，每个规范都可以通过资源管理器栏中的下拉菜单访问。