Routing-controllers: @Param default validation

Created on 20 Dec 2017 · 10Comments · Source: typestack/routing-controllers

Hi,

I found that This technique works not only with @Body but also with @Param, @QueryParam, @BodyParam and other decorators. in this validation docs article.

But by default @Param('id') id: number is not validated and accepts NaN as value in case of invalid id.
There is no validate option for @Param decorator, which mentioned in the docs.

So mb you need a fix to be with your library docs.

Thanks.

question

Source

jsmonkey

Most helpful comment

And the pro of open source is that you don’t have to spend weeks and months writing software that others already has written. Feel free to fork and use you own version anytime, just don’t forget to push your fixes upstream, thanks!

NoNameProvided on 22 Dec 2017

👍3

All 10 comments

I was confused by this also and also a follow up question: Is there anyway to validate a route param at all? Assuming route params are primitives (string/number) - is there a way to specify a class property to validate against?

Let's say I have a model:

class User {

  @IsUUID('4')
  uuid: string
}

Would it be possible to have a property selector or something like

@JsonController('/users')
class UserController {

  @Get('/:uuid')
  get (@Param('uuid', user => user.uuid) uuid: string) {
  }
}

timc13 on 20 Dec 2017

Validation works only with classes annotated with class-validator decorators.
Extented normalization of params from path/query + validation for @Params and @QueryParams will be in 0.8.x - #315 😉

MichalLytek on 21 Dec 2017

Merge request is in opened state since 31 Aug. When will it be released?

jsmonkey on 21 Dec 2017

I have no idea, pleerock is a busy guy. You can use my fork - @19majkel94/routing-controllers :wink:

MichalLytek on 21 Dec 2017

❤1

@19majkel94 Can you provide an example of how that would work in the new release with the model & controller that I posted above? I am using @IsUUID decorate from class-validator...

timc13 on 21 Dec 2017

@JsonController('/users')
class UserController {

  @Get('/:uuid')
  get (@Params() { uuid }: User) {
    // here uuid will be valid, if not it won't enter this method and throw 400 Bad Request
  }
}

But you should create a separate class, eg.:

class GetParams{
  @IsUUID('4')
  uuid: string
}

This is the living documentation of the API - you can change the internal representation of User model and just update the get method of UserController without changing how the API looks from outside.

MichalLytek on 21 Dec 2017

👍1

That's the cons of opensource. It's normal to release the product which is not working according to the docs with bugs and no one knows when the fixes will arrive. Anyways thanks for the suggestions.

jsmonkey on 22 Dec 2017

NoNameProvided on 22 Dec 2017

👍3

just use:

@JsonController('/users')
class UserController {

  @Get('/:uuid(\\d+)')
  get (@Param('uuid') uuid: number) {
    // if the uuid does't match `\d+` the request will not go into this handler, and express will throw a 404 page.
  }
}