New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document via decorators? #67

Open

milesj opened this issue Mar 28, 2024 · 0 comments

milesj commented Mar 28, 2024

I'm not entirely sure if this is possible, but could decorators be used for providing more information? For example:

export default class AuthLoginController {
  @ApiInfo('Login to the application')
  @ApiRequest<InputShape>()
  @ApiResponse<OutputShape>(200)
  async handle({ auth, request, response }: HttpContext) {
    // Do something
  }
}

Adds a bit more type safety and control than JSDoc tags.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment