Method serveDocuments

lib/swagger-module.ts:123–176

(
    finalPath: string,
    urlLastSubdirectory: string,
    httpAdapter: HttpServer,
    documentOrFactory: OpenAPIObject | (() => OpenAPIObject),
    options: {
      ui: boolean;
      raw: boolean | Array<'json' | 'yaml'>;
      jsonDocumentUrl: string;
      yamlDocumentUrl: string;
      swaggerOptions: SwaggerCustomOptions;
    }
  )

  }

  protected static serveDocuments(
    finalPath: string,
    urlLastSubdirectory: string,
    httpAdapter: HttpServer,
    documentOrFactory: OpenAPIObject | (() => OpenAPIObject),
    options: {
      ui: boolean;
      raw: boolean | Array<'json' | 'yaml'>;
      jsonDocumentUrl: string;
      yamlDocumentUrl: string;
      swaggerOptions: SwaggerCustomOptions;
    }
  ) {
    let document: OpenAPIObject;

    const getBuiltDocument = () => {
      if (!document) {
        document =
          typeof documentOrFactory === 'function'
            ? documentOrFactory()
            : documentOrFactory;
      }
      return document;
    };

    if (options.ui) {
      this.serveSwaggerUi(
        finalPath,
        urlLastSubdirectory,
        httpAdapter,
        getBuiltDocument,
        options.swaggerOptions
      );
    }

    /**
     * Serve JSON/YAML definitions based on the `raw` option:
     * - `true`: Serve both JSON and YAML definitions.
     * - `false`: Skip registering both JSON and YAML definitions.
     * - `Array<'json' | 'yaml'>`: Serve only the specified formats (e.g., `['json']` to serve only JSON).
     */
    if (
      options.raw === true ||
      (Array.isArray(options.raw) && options.raw.length > 0)
    ) {
      const serveJson = options.raw === true || options.raw.includes('json');
      const serveYaml = options.raw === true || options.raw.includes('yaml');

      this.serveDefinitions(httpAdapter, getBuiltDocument, options, {
        serveJson,
        serveYaml
      });
    }
  }

  protected static serveSwaggerUi(
    finalPath: string,