Handling of Response Codes / Types about tsoa

[azaeng04]

@isman-usoh where does ErrorResponse come from in your code?

[isman-usoh]

@egandro

import {Post, Route, Request, SuccessResponse, Response, Controller } from 'tsoa';

@Route('Users')
export class UsersController extends Controller {

    @Response<ErrorResponse>('Unexpected error') // error response
    @SuccessResponse('201', 'Created') // custom success response
    @Post()
    public async createUser(@Body() requestBody: UserCreationRequest): Promise<void> {
        new UserService().create(request);
        this.setStatus(201); // set return status 201
        return Promise.resolve();
    }
}

[azaeng04]

@isman-usoh that example you showed does not show the ErrorResponse object on the Swagger Doc.

This is the code I have and it does not display it in the Swagger Doc:

import { Route, Controller, Get, Query, SuccessResponse, Tags, Response } from 'tsoa';
import { ExpenseGroup } from "../../models";
import { IExpenseGroupResponse, ErrorResponse } from "../response";

@Route('expenseGroup')
export class ExpenseGroupController extends Controller {
    @Response<ErrorResponse>('The following error occurred')
    @SuccessResponse('200', 'Expense Group found')
    @Tags('Expense Group')
    @Get('')
    public async getExpenseGroupById(@Query() id: number): Promise<IExpenseGroupResponse> {
        const expenseGroup = await ExpenseGroup.findById(id);
        const customResponse = <IExpenseGroupResponse> expenseGroup;
        this.setStatus(200);
        return customResponse;
    }
}