Automatically detect optional @Query

Am I right in thinking that you could look for a ? on the query function parameter to denote that it is optional, and pick this up to set the required value on the swagger document?

It would be nicer than having to add decorators like @ApiImplicitQuery({name:'offset',required:false}) to the method I think. What do you reckon?

Thanks 😃

[jaufgang]

Keep in mind that a param could also be optional if it has a default value rather than a ?. For example:

@Controller("transactions")
export class TransactionsController {

	@ApiImplicitQuery({
		name: "limit",
		description: "The maximum number of transactions to return",
		required: false,
		type: Number
	})
	@Get("recent")
	getRecentTransactions(@Query("limit", new ToIntPipe()) limit: Number = 10) {
		...
	}
}

It would be ideal if swagger could detect the default value using reflection and document that the param is optional as well as the default values.

Also, note that in this example the param type is explicitly declared as Number, but this is also not reflected in the swagger docs if we omit the @ApiImplicitQuery({type: Number}). In fact, the try it out form field will currently not accept a number without the type specified in the ApiImplicitQuery decorator.

It would be ideal if all of these things could be inferred by reflection so that you would only need to use the @ApiImplicitQuery decorator to add the description.

[mjgp2]

Sure, good idea, but I would still rather have something where the API properties can be inferred by reflection rather than more decorators as it becomes much more verbose 👍