Swashbuckle - swagger documentation of returned response?

Question

Swashbuckle would not generate swagger.json with an output of "UserCreateResponse", how do you fix this?

    [HttpPost]
    public async Task Update([FromBody]UserCreate Request)
    {
        UserCreateResponse response = new UserCreateResponse();

        //do something here

        // returns UserCreateResponse with http status code 200
        return Ok(response);
    }

You can't do this, because its not going to return the http status code, 200,400,401 etc

    [HttpPost]
    public async Task Update([FromBody]UserCreate Request)
    {
        UserCreateResponse response = new UserCreateResponse();

        //do something here

        // returns UserCreateResponse
        return response;
    }

user_968003 · Answer

Starting from .NET Core 2.1, using ActionResult would be the recommended approach to specify the returned type. It gets picked by Swashbuckle and also adds type checks at the compilation.

You also can add description on the response via XML comment (docs).

So for the OP's example it would be

///  
///     Update the user 
/// 
///  User's data 
[HttpPost]
[ProducesResponseType(StatusCodes.Status200OK)]
public async Task> Update(...) 
{
   ...
}

Swashbuckle - swagger documentation of returned response?

3 Answers