How to provide JSON response schema?

@ApiResponse({ status: 201, description: 'Creates new player object.' })

Only (I think) allows for the status and description (plus some other fields). How can I implicitly or explicitly (^^) force SwaggerModule to show the JSON that will be returned?

[galkowskit]

But that’s the input? For POST I use @ApiModelProperty in the .dto files. I mean the output from the API. My API is connected via TypeORM to PostgreSQL.

  @Post()
  @UsePipes(new ValidationPipe())
  @ApiResponse({ status: 201, type: User, description: 'Creates new user object.' })
  async create (@Body() createUserDto: CreateUserDto): Promise<User> {
    const user = await this.userService.create(createUserDto)
    return this.userService.findOne(user.id)
  }

In Swagger UI I can see that CreateUserDto is used as a request body, that’s great. Should I create a similar class for output? Or is it somehow possible to derive the output from the User (TypeORM) object?

[kamilmysliwiec]

Hi @galkowskit, Use type property. Pass there a class with properties annotated with @ApiModelProperty()