release: version 9.0.0

e2e/api-spec.json

@@ -1,53 +1,9 @@
 {
   "openapi": "3.0.0",
   "paths": {
-    "/api/v1": {
-      "get": {
-        "operationId": "AppController_getHello_v1",
-        "parameters": [
-          {
-            "name": "x-tenant-id",
-            "in": "header",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": ""
-          }
-        },
-        "tags": [
-          "App"
-        ]
-      }
-    },
-    "/api/v2": {
-      "get": {
-        "operationId": "AppController_getHello_v2",
-        "parameters": [
-          {
-            "name": "x-tenant-id",
-            "in": "header",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": ""
-          }
-        },
-        "tags": [
-          "App"
-        ]
-      }
-    },
-    "/api/v1/alias1": {
+    "/api/v1/express:colon:another/{prop}": {
       "get": {
-        "operationId": "AppController_withAliases[0]_v1",
+        "operationId": "ExpressController_withColons_v1",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -63,13 +19,13 @@
           }
         },
         "tags": [
-          "App"
+          "Express"
         ]
       }
     },
-    "/api/v1/alias2": {
+    "/api/v2/express:colon:another/{prop}": {
       "get": {
-        "operationId": "AppController_withAliases[1]_v1",
+        "operationId": "ExpressController_withColons_v2",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -85,13 +41,13 @@
           }
         },
         "tags": [
-          "App"
+          "Express"
         ]
       }
     },
-    "/api/v2/alias1": {
+    "/api/v1": {
       "get": {
-        "operationId": "AppController_withAliases[2]_v2",
+        "operationId": "AppController_getHello_v1",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -111,9 +67,9 @@
         ]
       }
     },
-    "/api/v2/alias2": {
+    "/api/v2": {
       "get": {
-        "operationId": "AppController_withAliases[3]_v2",
+        "operationId": "AppController_getHello_v2",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -133,9 +89,9 @@
         ]
       }
     },
-    "/api/v1/express:colon:another/{prop}": {
+    "/api/v1/alias1": {
       "get": {
-        "operationId": "AppController_withColonExpress_v1",
+        "operationId": "AppController_withAliases[0]_v1",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -155,9 +111,9 @@
         ]
       }
     },
-    "/api/v2/express:colon:another/{prop}": {
+    "/api/v1/alias2": {
       "get": {
-        "operationId": "AppController_withColonExpress_v2",
+        "operationId": "AppController_withAliases[1]_v1",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -177,9 +133,9 @@
         ]
       }
     },
-    "/api/v1/fastify:{colon}:{another}/{prop}": {
+    "/api/v2/alias1": {
       "get": {
-        "operationId": "AppController_withColonFastify_v1",
+        "operationId": "AppController_withAliases[2]_v2",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -199,9 +155,9 @@
         ]
       }
     },
-    "/api/v2/fastify:{colon}:{another}/{prop}": {
+    "/api/v2/alias2": {
       "get": {
-        "operationId": "AppController_withColonFastify_v2",
+        "operationId": "AppController_withAliases[3]_v2",
         "parameters": [
           {
             "name": "x-tenant-id",
@@ -992,9 +948,9 @@
         ]
       }
     },
-    "/api/cats/site*": {
+    "/api/cats/wildcard/{splat}": {
       "get": {
-        "operationId": "CatsController_getSite",
+        "operationId": "CatsController_getWildcard",
         "parameters": [
           {
             "name": "header",

e2e/express.e2e-spec.ts

@@ -8,14 +8,19 @@ import * as request from 'supertest';
 import * as SwaggerParser from 'swagger-parser';
 import { DocumentBuilder, SwaggerModule } from '../lib';
 import { ApplicationModule } from './src/app.module';
+import { ExpressController } from './src/express.controller';
 
 describe('Express Swagger', () => {
   let app: NestExpressApplication;
   let builder: DocumentBuilder;
 
   beforeEach(async () => {
     app = await NestFactory.create<NestExpressApplication>(
-      ApplicationModule,
+      {
+        module: class {},
+        imports: [ApplicationModule],
+        controllers: [ExpressController]
+      },
       new ExpressAdapter(),
       { logger: false }
     );

e2e/fastify.e2e-spec.ts

@@ -8,14 +8,19 @@ import * as request from 'supertest';
 import * as SwaggerParser from 'swagger-parser';
 import { DocumentBuilder, SwaggerModule } from '../lib';
 import { ApplicationModule } from './src/app.module';
+import { FastifyController } from './src/fastify.controller';
 
 describe('Fastify Swagger', () => {
   let app: NestFastifyApplication;
   let builder: DocumentBuilder;
 
   beforeEach(async () => {
     app = await NestFactory.create<NestFastifyApplication>(
-      ApplicationModule,
+      {
+        module: class {},
+        imports: [ApplicationModule],
+        controllers: [FastifyController]
+      },
       new FastifyAdapter(),
       { logger: false }
     );

e2e/src/app.controller.ts

@@ -13,14 +13,4 @@ export class AppController {
   withAliases(): string {
     return 'Hello world!';
   }
-
-  @Get('express[:]colon[:]another/:prop')
-  withColonExpress(): string {
-    return 'Hello world!';
-  }
-
-  @Get('fastify::colon::another/:prop')
-  withColonFastify(): string {
-    return 'Hello world!';
-  }
 }

e2e/src/cats/cats.controller.ts

@@ -148,8 +148,8 @@ export class CatsController {
     return this.catsService.create(createCatDto);
   }
 
-  @Get('site*')
-  getSite() {}
+  @Get('wildcard/*')
+  getWildcard() {}
 
   @Get('with-enum/:type')
   @ApiParam({

e2e/src/express.controller.ts

@@ -0,0 +1,11 @@
+import { Controller, Get } from '@nestjs/common';
+
+@Controller({
+  version: ['1', '2']
+})
+export class ExpressController {
+  @Get('express\\:colon\\:another/:prop')
+  withColons(): string {
+    return 'Hello world!';
+  }
+}

e2e/src/fastify.controller.ts

@@ -0,0 +1,11 @@
+import { Controller, Get } from '@nestjs/common';
+
+@Controller({
+  version: ['1', '2']
+})
+export class FastifyController {
+  @Get('fastify::colon::another/:prop')
+  withColons(): string {
+    return 'Hello world!';
+  }
+}

e2e/validate-schema.e2e-spec.ts

@@ -13,15 +13,23 @@ import {
 import { ApplicationModule } from './src/app.module';
 import { Cat } from './src/cats/classes/cat.class';
 import { TagDto } from './src/cats/dto/tag.dto';
+import { ExpressController } from './src/express.controller';
 
 describe('Validate OpenAPI schema', () => {
   let app: INestApplication;
   let options: Omit<OpenAPIObject, 'paths'>;
 
   beforeEach(async () => {
-    app = await NestFactory.create(ApplicationModule, {
-      logger: false
-    });
+    app = await NestFactory.create(
+      {
+        module: class {},
+        imports: [ApplicationModule],
+        controllers: [ExpressController]
+      },
+      {
+        logger: false
+      }
+    );
     app.setGlobalPrefix('api/');
     app.enableVersioning();
 

lib/swagger-explorer.ts

@@ -13,7 +13,6 @@ import {
 } from '@nestjs/common/interfaces';
 import {
   addLeadingSlash,
-  isString,
   isUndefined
 } from '@nestjs/common/utils/shared.utils';
 import { ApplicationConfig, MetadataScanner } from '@nestjs/core';
@@ -31,7 +30,7 @@ import {
   omitBy,
   pick
 } from 'lodash';
-import * as pathToRegexp from 'path-to-regexp';
+import { parse } from 'path-to-regexp';
 import { DECORATORS } from './constants';
 import { exploreApiCallbacksMetadata } from './explorers/api-callbacks.explorer';
 import { exploreApiExcludeControllerMetadata } from './explorers/api-exclude-controller.explorer';
@@ -353,12 +352,19 @@ export class SwaggerExplorer {
         );
         if (requestMethod === RequestMethod.ALL) {
           // Workaround for the invalid "ALL" Method
-          const validMethods = Object.values(RequestMethod).filter(
-            (meth) => meth !== 'ALL' && typeof meth === 'string'
-          ) as string[];
+          const validMethods = [
+            'get',
+            'post',
+            'put',
+            'delete',
+            'patch',
+            'options',
+            'head',
+            'search'
+          ];
 
           return validMethods.map((requestMethod) => ({
-            method: requestMethod.toLowerCase(),
+            method: requestMethod,
             path: fullPath === '' ? '/' : fullPath,
             operationId: `${this.getOperationId(
               instance,
@@ -430,8 +436,32 @@ export class SwaggerExplorer {
       path = head(path);
     }
     let pathWithParams = '';
-    for (const item of pathToRegexp.parse(path)) {
-      pathWithParams += isString(item) ? item : `${item.prefix}{${item.name}}`;
+
+    try {
+      let normalizedPath = path.endsWith('*')
+        ? path.replace(/\*$/, '*splat')
+        : path;
+
+      normalizedPath = normalizedPath.replace(/::/g, '\\:');
+      normalizedPath = normalizedPath.replace(/\[:\]/g, '\\:');
+
+      const { tokens } = parse(normalizedPath);
+      for (const item of tokens) {
+        if (item.type === 'text') {
+          pathWithParams += item.value;
+        } else if (item.type === 'param') {
+          pathWithParams += `{${item.name}}`;
+        } else if (item.type === 'wildcard') {
+          pathWithParams += `{splat}`;
+        }
+      }
+    } catch (err) {
+      // TODO: add error logging
+      console.error(err);
+      console.log('faiel to parse path', {
+        path
+      });
+      return '';
     }
     return pathWithParams === '/' ? '' : addLeadingSlash(pathWithParams);
   }

lib/swagger-scanner.ts

@@ -85,7 +85,7 @@ export class SwaggerScanner {
             });
         }
         const modulePath = this.getModulePathMetadata(container, metatype);
-        result = result.concat(
+        return result.concat(
           this.scanModuleControllers(
             controllers,
             modulePath,
@@ -96,7 +96,6 @@ export class SwaggerScanner {
             autoTagControllers
           )
         );
-        return this.transformer.unescapeColonsInPath(app, result);
       }
     );