QueryParams are parsed as separate params

[stefan-malcek]

Solves #39

QueryParams object is split into separate params in Swagger UI. I even added a Swagger UI page and a QueryParams decorator on getAll action to the example project in order to simply show new changes.

Note: class-validator-jsonschema has become a direct dependency. Is it a problem?

[epiphone]

Cool! Can we get a few tests in too?

[epiphone]

I'm not a huge fan of calling validationMetadatasToSchemas here and having class-validator as a dependency.

Can we instead find the query object among the schemas passed in via the additionalProperties argument?

[stefan-malcek]

Sure, I committed the changes.

What do you think about this line?
const spec = getSpec(routes, additionalProperties.components?.schemas || {})

Both components and schemas are optional, so I needed to provide a default value to keep TS happy.

Gonna write some tests.

[stefan-malcek]

@epiphone tests done

[epiphone]

That works well, I think.

[epiphone]

Nice work!

The only problem I found was that building the sample now fails in some sort of a type error:

app.ts:43:9 - error TS2345: Argument of type '"/docs"' is not assignable to parameter of type 'RequestHandlerParams'.

43 app.use('/docs', swaggerUiExpress.serve, swaggerUiExpress.setup(spec));
           ~~~~~~~

node_modules/@types/swagger-ui-express/node_modules/@types/express/index.d.ts:98:50 - error TS2694: Namespace '"/home/ap/koodi/routing-controllers-openapi/sample/01-basic/node_modules/@types/express-serve-static-core/index"' has no exported member 'Params'.

98     interface ErrorRequestHandler<P extends core.Params = core.ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = core.Query>
                                                    ~~~~~~
...

I did a rm -rf node_modules && yarn install && yarn build to trigger that.

Also please commit in the updated sample project yarn.lock file.

[stefan-malcek]

Nice work!

The only problem I found was that building the sample now fails in some sort of a type error:

app.ts:43:9 - error TS2345: Argument of type '"/docs"' is not assignable to parameter of type 'RequestHandlerParams'.

43 app.use('/docs', swaggerUiExpress.serve, swaggerUiExpress.setup(spec));
           ~~~~~~~

node_modules/@types/swagger-ui-express/node_modules/@types/express/index.d.ts:98:50 - error TS2694: Namespace '"/home/ap/koodi/routing-controllers-openapi/sample/01-basic/node_modules/@types/express-serve-static-core/index"' has no exported member 'Params'.

98     interface ErrorRequestHandler<P extends core.Params = core.ParamsDictionary, ResBody = any, ReqBody = any, ReqQuery = core.Query>
                                                    ~~~~~~
...

I did a rm -rf node_modules && yarn install && yarn build to trigger that.

Also please commit in the updated sample project yarn.lock file.

There was a problem with the @types/express-serve-static-core package. Setting it in package.json as a dev dependency should do it.

Some references:
DefinitelyTyped/DefinitelyTyped#40905
DefinitelyTyped/DefinitelyTyped#40138

[epiphone]

Awesome, thanks!