interview

home / developersection / interviews / what are the return types of api methods in .net core?q

Ask Question
Utpal Vishwas

I am Utpal Vishwas from Uttar Pradesh. Have completed my B. Tech. course from MNNIT campus Prayagraj in 2022. I have good knowledge of computer networking.

Can you answer this question?
Answer

1 Answers

Utpal Vishwas

Utpal Vishwas

20-May-2025

In ASP.NET Core, Web API methods (also called action methods) can return various types depending on the scenario. Here’s a breakdown of the most common return types for API methods:

1. IActionResult / ActionResult<T> (Recommended)

These return types give you flexibility to return different HTTP status codes and data.

a. IActionResult

Lets you return various types like Ok(), BadRequest(), NotFound(), etc.

[HttpGet]
public IActionResult GetItem(int id)
{
    if (id <= 0)
        return BadRequest("Invalid ID");

    var item = repository.Get(id);
    if (item == null)
        return NotFound();

    return Ok(item); // 200 OK + JSON
}

b. ActionResult<T>

  • Combines type-safety with HTTP response flexibility.
  • Automatically wraps the returned object in Ok(...) if not explicitly handled.
[HttpGet("{id}")]
public ActionResult<Item> GetItem(int id)
{
    var item = repository.Get(id);
    if (item == null)
        return NotFound();

    return item; // Automatically 200 OK with JSON
}

2. Concrete Type (e.g., string, List<T>, etc.)

  • Simpler, but not flexible (always returns 200 OK).
  • Best for internal or simple APIs.
[HttpGet]
public string GetGreeting()
{
    return "Hello!";
}

3. Task<IActionResult> / Task<ActionResult<T>> (for async)

If your API method performs async operations (e.g., I/O, DB calls), return Task<...>:

[HttpGet("{id}")]
public async Task<ActionResult<Item>> GetItemAsync(int id)
{
    var item = await _context.Items.FindAsync(id);
    if (item == null)
        return NotFound();

    return item;
}

4. IEnumerable<T> / List<T>

Returns a list of items, automatically serialized as JSON with 200 OK:

[HttpGet]
public IEnumerable<Item> GetAllItems()
{
    return _context.Items.ToList();
}

Summary Table

Return Type Use When You Need… Notes
IActionResult Full control over status codes & responses Best for multiple outcomes
ActionResult<T> Return a value or a status code cleanly Combines flexibility + type
T (concrete type) Simple, always 200 OK Less control
Task<IActionResult> Async with status control Preferred for async methods
Task<ActionResult<T>> Async + data + status code Recommended for async data APIs
IEnumerable<T> / List<T> Return a list of data Always returns 200 OK

Let me know if you want examples with file downloads, error handling, or streaming responses.

MindStick Training
MindStick Training

Liked By

We use cookies to ensure you have the best browsing experience on our website. By using our site, you acknowledge that you have read and understood our Cookie Policy & Privacy Policy