.net core asp.net web api action returning unexpected status code

Question

I have set up this action:

[HttpPost]
[ProducesResponseType(typeof(Category), StatusCodes.Status201Created)]
[ProducesResponseType(StatusCodes.Status400BadRequest)]
public async Task<IActionResult> CreateAsync(CategoryViewModel category)
{
    if (category == null) return BadRequest();
    if (!ModelState.IsValid) return BadRequest(ModelState);
    if (!category.Fields.Any()) return BadRequest();

    var request = Factory.Create(category);

    _categoryService.Save(request);
    await _categoryService.SaveChangesAsync();

    return Ok(category);
}

The response type should be Category with a status code of 201, but when I run my tests I get a status code of 200. This is my test:

    [Test]
    public async Task CreateCategory()
    {
        // Assemble
        const string categoryId = "cameras";
        var services = ControllerContext.GivenServices();
        var controller = services.WhenCreateController();
        var field = new Field { CategoryId = categoryId, Name = "Title" };
        var category = new CategoryViewModel { Id = categoryId, Name = "Cameras", Fields = new List<Field>{ field } };

        // Act
        var result = await controller.CreateAsync(category);
        var okObjectResult = result as OkObjectResult;

        // Assert
        okObjectResult.Should().NotBeNull();
        Assert.AreEqual(StatusCodes.Status201Created, okObjectResult?.StatusCode);

        services.MockCategoryService.Verify(m => m.Save(It.IsAny<Category>()), Times.Once);
        services.MockCategoryService.Verify(m => m.SaveChangesAsync(), Times.Once);
    }

This test fails on this line: Assert.AreEqual(StatusCodes.Status201Created, okObjectResult?.StatusCode); because it is returning 200 instead.

Does anyone know why?

Why do you think it should be 201? You're calling the Ok() method (as in OK 200). — Kenneth K.
– Kenneth K., Commented Jul 25, 2019 at 15:25

Vivien Sonntag · Accepted Answer · 2019-07-25 15:35:19Z

4

The ProducesResponseType-Attribute is not what determines what your Action returns, it is used for things like swagger/OpenAPI to create documentation.

You need to change the return value of your Action to return Created(UriOfTheCreatedResource, category) instead of return Ok(category).

Documentation

edited Jul 25, 2019 at 15:35

answered Jul 25, 2019 at 15:29

Vivien Sonntag

4,6591 gold badge29 silver badges54 bronze badges

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

Collectives™ on Stack Overflow

.net core asp.net web api action returning unexpected status code

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related