QueryParams are parsed as separate params

.gitignore

@@ -2,6 +2,7 @@ npm-debug*
 build
 node_modules
 coverage
+.idea/
 .vscode/
 *.key
 *.secret

__tests__/decorators.test.ts

@@ -192,46 +192,46 @@ describe('decorators', () => {
   })
 
   it('merges keywords defined in @OpenAPI decorator into operation', () => {
-    const operation = getOperation(routes.listUsers)
+    const operation = getOperation(routes.listUsers, {})
     expect(operation.description).toEqual('List all users')
   })
 
   it('applies @OpenAPI decorator function parameter to operation', () => {
-    const operation = getOperation(routes.getUser)
+    const operation = getOperation(routes.getUser, {})
     expect(operation.tags).toEqual(['Users', 'custom-tag'])
   })
 
   it('merges consecutive @OpenAPI object parameters top-down', () => {
-    const operation = getOperation(routes.multipleOpenAPIsWithObjectParam)
+    const operation = getOperation(routes.multipleOpenAPIsWithObjectParam, {})
     expect(operation.summary).toEqual('Some summary')
     expect(operation.description).toEqual('Some description')
     expect(operation['x-custom-key']).toEqual('Custom value')
   })
 
   it('applies consecutive @OpenAPI function parameters top-down', () => {
-    const operation = getOperation(routes.multipleOpenAPIsWithFunctionParam)
+    const operation = getOperation(routes.multipleOpenAPIsWithFunctionParam, {})
     expect(operation.summary).toEqual('Some summary')
     expect(operation.description).toEqual('Some description')
     expect(operation['x-custom-key']).toEqual(20)
   })
 
   it('merges and applies consecutive @OpenAPI object and function parameters top-down', () => {
-    const operation = getOperation(routes.multipleOpenAPIsWithMixedParam)
+    const operation = getOperation(routes.multipleOpenAPIsWithMixedParam, {})
     expect(operation.summary).toEqual('Some summary')
     expect(operation.description).toEqual('Some description')
     expect(operation['x-custom-key']).toEqual(20)
   })
 
   it('applies @ResponseSchema merging in response schema into source metadata', () => {
-    const operation = getOperation(routes.responseSchemaDefaults)
+    const operation = getOperation(routes.responseSchemaDefaults, {})
     // ensure other metadata doesnt get overwritten by decorator
     expect(operation.operationId).toEqual(
       'UsersController.responseSchemaDefaults'
     )
   })
 
   it('applies @ResponseSchema using default contentType and statusCode', () => {
-    const operation = getOperation(routes.responseSchemaDefaults)
+    const operation = getOperation(routes.responseSchemaDefaults, {})
     expect(operation.responses).toEqual({
       '200': {
         content: {
@@ -247,7 +247,7 @@ describe('decorators', () => {
   })
 
   it('applies @ResponseSchema using contentType and statusCode from options object', () => {
-    const operation = getOperation(routes.responseSchemaOptions)
+    const operation = getOperation(routes.responseSchemaOptions, {})
     expect(operation.responses).toEqual({
       '200': {
         content: {
@@ -269,14 +269,14 @@ describe('decorators', () => {
   })
 
   it('applies @ResponseSchema using contentType and statusCode from decorators', () => {
-    const operation = getOperation(routes.responseSchemaDecorators)
+    const operation = getOperation(routes.responseSchemaDecorators, {})
     expect(operation.responses['201'].content['application/pdf']).toEqual({
       schema: { $ref: '#/components/schemas/ModelDto' }
     })
   })
 
   it('applies @ResponseSchema using isArray flag set to true', () => {
-    const operation = getOperation(routes.responseSchemaArray)
+    const operation = getOperation(routes.responseSchemaArray, {})
     expect(operation.responses['200'].content['application/json']).toEqual({
       schema: {
         items: {
@@ -288,7 +288,7 @@ describe('decorators', () => {
   })
 
   it('applies @ResponseSchema using contentType and statusCode from options object, overruling options from RC decorators', () => {
-    const operation = getOperation(routes.responseSchemaDecoratorAndSchema)
+    const operation = getOperation(routes.responseSchemaDecoratorAndSchema, {})
     expect(operation.responses).toEqual({
       '201': {
         content: {
@@ -308,7 +308,7 @@ describe('decorators', () => {
   })
 
   it('applies @ResponseSchema using a string as ModelName', () => {
-    const operation = getOperation(routes.responseSchemaModelAsString)
+    const operation = getOperation(routes.responseSchemaModelAsString, {})
     expect(operation.responses).toEqual({
       '200': {
         content: {
@@ -329,7 +329,7 @@ describe('decorators', () => {
 
   it('applies @ResponseSchema while retaining inner OpenAPI decorator', () => {
     const operation = getOperation(
-      routes.responseSchemaNotOverwritingInnerOpenApiDecorator
+      routes.responseSchemaNotOverwritingInnerOpenApiDecorator, {}
     )
     expect(operation.description).toEqual('somedescription')
     expect(operation.responses).toEqual({
@@ -352,7 +352,7 @@ describe('decorators', () => {
 
   it('applies @ResponseSchema while retaining outer OpenAPI decorator', () => {
     const operation = getOperation(
-      routes.responseSchemaNotOverwritingOuterOpenApiDecorator
+      routes.responseSchemaNotOverwritingOuterOpenApiDecorator, {}
     )
     expect(operation.description).toEqual('somedescription')
     expect(operation.responses).toEqual({
@@ -374,7 +374,7 @@ describe('decorators', () => {
   })
 
   it('does not apply @ResponseSchema if empty ModelName is passed', () => {
-    const operation = getOperation(routes.responseSchemaNoNoModel)
+    const operation = getOperation(routes.responseSchemaNoNoModel, {})
     expect(operation.responses).toEqual({
       '200': {
         content: {
@@ -386,7 +386,7 @@ describe('decorators', () => {
   })
 
   it('applies @ResponseSchema using default contentType and statusCode from @Controller (non-json)', () => {
-    const operation = getOperation(routes.responseSchemaDefaultsHtml)
+    const operation = getOperation(routes.responseSchemaDefaultsHtml, {})
     expect(operation.responses).toEqual({
       '200': {
         content: {
@@ -402,7 +402,7 @@ describe('decorators', () => {
   })
 
   it('applies multiple @ResponseSchema on a single handler', () => {
-    const operation = getOperation(routes.multipleResponseSchemas)
+    const operation = getOperation(routes.multipleResponseSchemas, {})
     expect(operation.responses).toEqual({
       '200': {
         content: {
@@ -474,7 +474,7 @@ describe('@OpenAPI-decorated class', () => {
   })
 
   it('applies controller OpenAPI props to each method with method-specific props taking precedence', () => {
-    expect(getOperation(routes.listItems)).toEqual(
+    expect(getOperation(routes.listItems, {})).toEqual(
       expect.objectContaining({
         description: 'List all items',
         externalDocs: { url: 'http://docs.com' },
@@ -483,7 +483,7 @@ describe('@OpenAPI-decorated class', () => {
       })
     )
 
-    expect(getOperation(routes.getItem)).toEqual(
+    expect(getOperation(routes.getItem, {})).toEqual(
       expect.objectContaining({
         description: 'Common description',
         externalDocs: { url: 'http://docs.com' },

__tests__/fixtures/spec.json

@@ -220,10 +220,22 @@
           },
           {
             "in": "query",
-            "name": "ListUsersQueryParams",
+            "name": "email",
             "required": false,
             "schema": {
-              "$ref": "#/components/schemas/ListUsersQueryParams"
+              "format": "email",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "types",
+            "required": true,
+            "schema": {
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
             }
           }
         ],

__tests__/options.test.ts

@@ -57,24 +57,24 @@ describe('options', () => {
 
   it('sets query parameter optional by default', () => {
     const route = routes[0]
-    expect(getQueryParams(route)[0].required).toEqual(false)
+    expect(getQueryParams(route, {})[0].required).toEqual(false)
   })
 
   it('sets query parameter required as per global options', () => {
     const route = routes[0]
     route.options.defaults = { paramOptions: { required: true } }
-    expect(getQueryParams(route)[0].required).toEqual(true)
+    expect(getQueryParams(route, {})[0].required).toEqual(true)
   })
 
   it('uses local required option over the global one', () => {
     const route = routes[0]
     route.options.defaults = { paramOptions: { required: true } }
-    expect(getQueryParams(route)[1].required).toEqual(false)
+    expect(getQueryParams(route, {})[1].required).toEqual(false)
   })
 
   it('uses the explicit `type` parameter to override request query type', () => {
     const route = routes[1]
-    expect(getQueryParams(route)[0]).toEqual({
+    expect(getQueryParams(route, {})[0]).toEqual({
       in: "query",
       name: "param",
       required: false,

__tests__/parameters.test.ts

@@ -17,16 +17,33 @@ import {
   IRoute,
   parseRoutes
 } from '../src'
+import { SchemaObject } from 'openapi3-ts'
+import { validationMetadatasToSchemas } from 'class-validator-jsonschema'
+import { IsBoolean, IsNumber, IsOptional, IsString } from 'class-validator'
+import { defaultMetadataStorage } from 'class-transformer/storage'
 
 describe('parameters', () => {
   let route: IRoute
+  let schemas: { [p: string]: SchemaObject }
 
   beforeAll(() => {
-    class ListUsersHeaderParams {}
-    class ListUsersQueryParams {}
+    class ListUsersHeaderParams {
+    }
+
+    class ListUsersQueryParams {
+      @IsNumber()
+      genderId: number
+
+      @IsBoolean()
+      @IsOptional()
+      isPretty: boolean
+
+      @IsString({ each: true })
+      types: string[]
+    }
 
     @JsonController('/users')
-    // @ts-ignore: not referenced
+      // @ts-ignore: not referenced
     class UsersController {
       @Get('/:string/:regex(\\d{6})/:optional?/:number/:boolean/:any')
       getPost(
@@ -36,7 +53,7 @@ describe('parameters', () => {
         @Param('any') _anyParam: any,
         @QueryParam('limit') _limit: number,
         @HeaderParam('Authorization', { required: true })
-        _authorization: string,
+          _authorization: string,
         @QueryParams() _queryRef?: ListUsersQueryParams,
         @HeaderParams() _headerParams?: ListUsersHeaderParams
       ) {
@@ -45,6 +62,10 @@ describe('parameters', () => {
     }
 
     route = parseRoutes(getMetadataArgsStorage())[0]
+    schemas = validationMetadatasToSchemas({
+      classTransformerMetadataStorage: defaultMetadataStorage,
+      refPointerPrefix: '#/components/schemas/'
+    })
   })
 
   it('parses path parameter from path strings', () => {
@@ -134,7 +155,7 @@ describe('parameters', () => {
   })
 
   it('parses query param from @QueryParam decorator', () => {
-    expect(getQueryParams(route)[0]).toEqual({
+    expect(getQueryParams(route, schemas)[0]).toEqual({
       in: 'query',
       name: 'limit',
       required: false,
@@ -143,12 +164,40 @@ describe('parameters', () => {
   })
 
   it('parses query param ref from @QueryParams decorator', () => {
-    expect(getQueryParams(route)[1]).toEqual({
-      in: 'query',
-      name: 'ListUsersQueryParams',
-      required: false,
-      schema: { $ref: '#/components/schemas/ListUsersQueryParams' }
-    })
+    expect(getQueryParams(route, schemas)).toEqual([
+      // limit comes from @QueryParam
+      {
+        in: 'query',
+        name: 'limit',
+        required: false,
+        schema: { type: 'number' }
+      },
+      {
+        in: 'query',
+        name: 'genderId',
+        required: true,
+        schema: { type: 'number' }
+      },
+      {
+        in: 'query',
+        name: 'isPretty',
+        required: false,
+        schema: {
+          type: 'boolean'
+        }
+      },
+      {
+        in: 'query',
+        name: 'types',
+        required: true,
+        schema: {
+          items: {
+            type: 'string'
+          },
+          type: 'array'
+        }
+      }
+    ])
   })
 
   it('parses header param from @HeaderParam decorator', () => {

sample/01-basic/UsersController.ts

@@ -1,11 +1,12 @@
-import { IsOptional, IsString, MaxLength } from 'class-validator'
+import { IsOptional, IsString, MaxLength, IsNumber, IsPositive } from 'class-validator'
 import {
   Body,
   Get,
   JsonController,
   Param,
   Post,
-  Put
+  Put,
+  QueryParams
 } from 'routing-controllers'
 import { OpenAPI } from 'routing-controllers-openapi'
 
@@ -18,14 +19,24 @@ class CreateUserBody {
   hobbies: string[]
 }
 
+class PaginationQuery {
+  @IsNumber()
+  @IsPositive()
+  public limit: number;
+
+  @IsNumber()
+  @IsOptional()
+  public offset?: number;
+}
+
 @OpenAPI({
   security: [{ basicAuth: [] }]
 })
 @JsonController('/users')
 export class UsersController {
   @Get('/')
   @OpenAPI({ summary: 'Return a list of users' })
-  getAll() {
+  getAll(@QueryParams() query: PaginationQuery) {
     return [
       { id: 1, name: 'First user!', hobbies: [] },
       { id: 2, name: 'Second user!', hobbies: ['fishing', 'cycling'] }

sample/01-basic/app.ts

@@ -6,6 +6,7 @@ import {
   getMetadataArgsStorage
 } from 'routing-controllers'
 import { routingControllersToSpec } from 'routing-controllers-openapi'
+import * as swaggerUiExpress from 'swagger-ui-express';
 
 import { UsersController } from './UsersController'
 
@@ -39,6 +40,8 @@ const spec = routingControllersToSpec(storage, routingControllersOptions, {
   }
 })
 
+app.use('/docs', swaggerUiExpress.serve, swaggerUiExpress.setup(spec));
+
 // Render spec on root:
 app.get('/', (_req, res) => {
   res.json(spec)