.Net Core Web API response with multiple properties

Question

I am designing an API endpoint and planning to send the response with 2 values ( one with total no of records and second with list of records ) The controller action is designed like below

    [HttpGet]
    [Route("users_bycat")]
    public async Task<ActionResult> GetUsersByCat([FromQuery] int categoryId )
    {       
        var query = db_context.Users.Select(a => a).Where(p => p.CategoryId == categoryId);                   
        var result = await query.ExecuteAsync();

        return Ok(
               new
               {
                   totalRecords = result.Count(),
                   users = result.ToList()
               }
            );
    }

When i am calling this api endpoint, i am getting response like below

    {
        "totalRecords": 37652,
        "users": []
    }

The users array is empty and i try like below , and managed to get the list as response , but i would like to add count as well to the response

    return Ok(  result.ToList());

How can i ensure i will get both totalRecords and users List as a part of response

You don't need to call query.ExecuteAsync() as query.ToList() will fetch the result, in fact, you can remove the .Select(a => a) also. — Chris Pickford
– Chris Pickford, Commented May 19, 2021 at 11:03

Chris Pickford · Accepted Answer · 2021-05-19 11:10:48Z

4

The ExecuteAsync() is redundant as an IQueryable is materialised upon calling .ToList(). Additionally, calling .Count() will execute an additional database query so it's more efficient to move this call onto the List. The exception to this would be if you were implementing paging.

The below should function as required:

[HttpGet]
[Route("users_bycat")]
public async Task<ActionResult> GetUsersByCat([FromQuery] int categoryId )
{       
    var results = await db_context.Users
      .Where(p => p.CategoryId == categoryId)
      .ToListAsync();
    
    var dto = new
    {
      totalRecords = results.Count,
      users = results
    };

    return Ok(dto);
}

answered May 19, 2021 at 11:10

Chris Pickford

9,0606 gold badges50 silver badges76 bronze badges

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

Collectives™ on Stack Overflow

.Net Core Web API response with multiple properties

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