Routing-controllers: Should @BodyParam default to required?

Created on 14 Jun 2017 · 9Comments · Source: typestack/routing-controllers

Taking a stab at rebuilding a Ruby/Grape API with Koa2 and this library, extremely happy that it exists. Thank you for your work!

Something I noticed is that that Params specified in a request function are not required by default. Reading this signature, I'd expect it to raise an error if any fields are missing in my POST:

@Post('/buzz')
createSession(@BodyParam('foo') foo: string, @BodyParam('bar') bar: string, @BodyParam('baz') baz: string) { 
  // do something
}

I see I can add the { required: true } option, but I feel like the less surprising default would be a closer to match to what the TS function signature describes, which is "everything is required." As it stands, the default forces us to treat each param as optional, so the TS signature does not accurately describe the input. Changing the default would make things safer and more trustworthy by default, which is a better user experience, IMO.

Source

subvertallchris

All 9 comments

Exactly this's what I feel, e.g. The current user decorator also requires to put required: true. What if we could just use TS signature.

chanlito on 30 Jun 2017

@BruceHem there's no way to use the reflection metadata to determine whether a parameter is required or not. That information is not emitted by the TS compiler.

marshall007 on 30 Jun 2017

Unfortunately as @marshall007 told we cannot use that information because typescript does not emit this information. We should ask typescript team to improve their reflection mechanizm and emit more data about code.

pleerock on 4 Jul 2017

New default option allows paramOptions to be required by default

useExpressServer(app, {

    defaults    : {
        paramOptions: {
            required: true // this means that all parameters (@BodyParam, @Param etc in Actions) are required by default
        }
    }
}

Very good.