Address additional PR feedback

nestjs · Aug 4, 2023 · 7cbe0ef · 7cbe0ef
1 parent 4731336
commit 7cbe0ef
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 20 deletions.
diff --git a/lib/interfaces/swagger-document-options.interface.ts b/lib/interfaces/swagger-document-options.interface.ts
@@ -1,7 +1,7 @@
 export type OperationIdFactory = (
   controllerKey: string,
   methodKey: string,
-  pathVersionKey?: string
+  version?: string
 ) => string;
 
 export interface SwaggerDocumentOptions {

diff --git a/lib/swagger-explorer.ts b/lib/swagger-explorer.ts
@@ -275,28 +275,17 @@ export class SwaggerExplorer {
       VERSION_METADATA,
       method
     );
+    const versioningOptions = applicationConfig.getVersioning();
     const controllerVersion = this.getVersionMetadata(
       metatype,
-      applicationConfig.getVersioning()
+      versioningOptions
     );
 
     const versionOrVersions = methodVersion ?? controllerVersion;
-    let versions: string[] = [];
-    if (!!versionOrVersions) {
-      if (Array.isArray(versionOrVersions)) {
-        versions = versionOrVersions.filter(
-          (v) => v !== VERSION_NEUTRAL
-        ) as string[];
-      } else if (versionOrVersions !== VERSION_NEUTRAL) {
-        versions = [versionOrVersions];
-      }
-
-      const versionConfig = applicationConfig.getVersioning();
-      if (versionConfig?.type == VersioningType.URI) {
-        const prefix = this.routePathFactory.getVersionPrefix(versionConfig);
-        versions = versions.map((v) => `${prefix}${v}`);
-      }
-    }
+    const versions = this.getRoutePathVersions(
+      versionOrVersions,
+      versioningOptions
+    );
 
     const allRoutePaths = this.routePathFactory.create(
       {
@@ -346,15 +335,37 @@ export class SwaggerExplorer {
   private getOperationId(
     instance: object,
     method: Function,
-    pathVersion?: string
+    version?: string
   ): string {
     return this.operationIdFactory(
       instance.constructor?.name || '',
       method.name,
-      pathVersion
+      version
     );
   }
 
+  private getRoutePathVersions(
+    versionValue?: VersionValue,
+    versioningOptions?: VersioningOptions
+  ) {
+    let versions: string[] = [];
+
+    if (!versionValue || versioningOptions?.type !== VersioningType.URI) {
+      return versions;
+    }
+
+    if (Array.isArray(versionValue)) {
+      versions = versionValue.filter((v) => v !== VERSION_NEUTRAL) as string[];
+    } else if (versionValue !== VERSION_NEUTRAL) {
+      versions = [versionValue];
+    }
+
+    const prefix = this.routePathFactory.getVersionPrefix(versioningOptions);
+    versions = versions.map((v) => `${prefix}${v}`);
+
+    return versions;
+  }
+
   private reflectControllerPath(metatype: Type<unknown>): string {
     return Reflect.getMetadata(PATH_METADATA, metatype);
   }