Generate response error in Swagger - .netCore Api

Question

For handling all errors I use ErrorHandlingMiddleware. Anywhere where I want I throw exception (my implementation exception) where I define type (enum) and message of errors. My question is how can I generate this type of error in swagger, becaouse swagger know only about controller return type values. And swagger generate only response (200) bcs in methods is only return Ok();

[HttpPost("login")]
public async Task<IActionResult> Test(LoginRequest req)
{
    if (user.Banned)
    {
        throw new BadRequestHorseedoException(ErrorCode.BANNED, "User is banned");
    }

    return Ok();
}

Lukasz Szczygielek · Accepted Answer · 2021-11-02 18:23:39Z

3

You can use ProducesResponseType attribute on methods. Your code can look like:

[HttpPost("login")]
[ProducesResponseType(StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status500InternalServerError)]
public async Task<IActionResult> Test(LoginRequest req)

answered Nov 2, 2021 at 18:23

Lukasz Szczygielek

3,1992 gold badges24 silver badges37 bronze badges

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

3 Comments

Merynek Over a year ago

I know about it but I have own ErrorResponse Class for all responses. And here I can only use StatusCodes Enum.

Merynek Over a year ago

I can handle like this:

[ProducesResponseType(200)] [ProducesResponseType(typeof(ErrorResponse), 400)] [ProducesResponseType(typeof(ErrorResponse), 401)] [ProducesResponseType(typeof(ErrorResponse), 500)]

But its so ugly :D

Lukasz Szczygielek Over a year ago

Yes, it's messy verbose. Maybe look at conventions learn.microsoft.com/en-us/aspnet/core/web-api/advanced/…

Collectives™ on Stack Overflow

Generate response error in Swagger - .netCore Api

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related