Reusable parameters NestJS OpenAPI

Question

Does the NestJS OpenAPI/Swagger implementation support reuse of common parameters?

This would save me from having to litter my endpoint with identical @ApiImplicitQuery decorators.

Kim Kern · Accepted Answer · 2019-05-01 09:42:53Z

2

You could just create your own reusable decorator:

const ApiRoleQuery = ApiImplicitQuery({
  name: 'role',
  enum: ['Admin', 'Moderator', 'User'],
});

and then use it in your controller:

@ApiRoleQuery
@Get()
async filterByRole(@Query('role') role) {
  // ...
}

answered May 1, 2019 at 9:42

Kim Kern

61.1k20 gold badges221 silver badges215 bronze badges

Sign up to request clarification or add additional context in comments.

1 Answer 1