Method createDocument

lib/swagger-module.ts:42–89

(
    app: INestApplication,
    config: Omit<OpenAPIObject, 'paths'>,
    options: SwaggerDocumentOptions = {}
  )

  }

  public static createDocument(
    app: INestApplication,
    config: Omit<OpenAPIObject, 'paths'>,
    options: SwaggerDocumentOptions = {}
  ): OpenAPIObject {
    const swaggerScanner = new SwaggerScanner();
    const document = swaggerScanner.scanApplication(app, options);
    const { webhooks: configWebhooks, ...configWithoutWebhooks } =
      config as OpenAPIObject;

    document.components = assignTwoLevelsDeep(
      {},
      config.components,
      document.components
    );
    const {
      webhooks: scannedWebhooks,
      webhookPaths,
      ...documentWithoutWebhooks
    } = document as OpenAPIObject & {
      webhookPaths?: OpenAPIObject['paths'];
    };
    const mergedWebhooks = SwaggerModule.mergeWebhooks(
      configWebhooks,
      scannedWebhooks
    );
    const shouldIncludeWebhooks = isOas31OrLater(config.openapi ?? '3.0.0');
    const baseDocument: OpenAPIObject = {
      openapi: '3.0.0',
      paths: {},
      ...configWithoutWebhooks,
      ...documentWithoutWebhooks
    };

    if (shouldIncludeWebhooks) {
      return {
        ...baseDocument,
        ...(mergedWebhooks ? { webhooks: mergedWebhooks } : {})
      };
    }

    return {
      ...baseDocument,
      paths: webhookPaths
        ? assignTwoLevelsDeep({}, baseDocument.paths || {}, webhookPaths)
        : baseDocument.paths
    };
  }

  public static async loadPluginMetadata(
    metadataFn: () => Promise<Record<string, any>>