How Return Void in Async Method in Web API

Question

I am calling a method in Web API(C#) from repository. The method is repository is not returning anything. It is Void. whay should I return in my API method as a async method cannot have a Void return type.

This is my Async method in API:

    [HttpPost]
    [Route("AddApp")]
    public async Task<?> AddApp([FromBody]Application app)
    {        
        loansRepository.InsertApplication(app);
    }

and this is EntityFrame work Insert in repository(I can cot change this by the way)

     public void InsertApplication(Application app)
    {

        this.loansContext.Application.Add(app);
    }

Sorry I made changes to the question, I am not sure what should I have for ? in the Task

@ Philippe Paré sorry made changes to the Code, I dont have any return type it is void. — Alma, May 04 '16 at 23:34
If the Web API method/action will not involve any async work (e.g. IO), you shouldn't really make it async — Yacoub Massad, May 04 '16 at 23:36
Yes @YacoubMassad is right, but if you need it to happen on another thread (if you don't want the code to block there), you can call `Task.Run(()=>//Your cp-bound work here, happening on another thread));` — Philippe Paré, May 04 '16 at 23:40

score 14 · Accepted Answer · answered May 04 '16 at 23:34

If you do not want to return anything then the return type should be Task.

[HttpPost]
[Route("AddApp")]
public async Task AddApp([FromBody]Application app)
{
    // When you mark a method with "async" keyword then:
    // - you should use the "await" keyword as well; otherwise, compiler warning occurs
    // - the real return type will be:
    // -- "void" in case of "Task"
    // -- "T" in case of "Task<T>"
    await loansRepository.InsertApplication(app);
}

public Task InsertApplication(Application app)
{
    this.loansContext.Application.Add(app);

    // Without "async" keyword you should return a Task instance.
    // You can use this below if no Task is created inside this method.
    return Task.FromResult(0);
}

You can also return Task.CompletedTask instead of FromResult(0) — Davy, Apr 14 '23 at 11:49

score 8 · Answer 2 · answered May 05 '16 at 01:08

8

Since you "cannot" change the Entity Framework repository, you shouldn't make your action method asynchronous, and you should just return void:

[HttpPost]
[Route("AddApp")]
public void AddApp([FromBody]Application app)
{        
    loansRepository.InsertApplication(app);
}

answered May 05 '16 at 01:08

Stephen Cleary

437,863
77
675
810

2

Stephen is the authority on all things async - I would go with his answer. – Sam Rueby May 05 '16 at 01:52
How would you then call this method from a C# client? – Faith Wins Nov 21 '16 at 18:50
@FaithWins: You'd post to `/AddApp` with the serialized `Application` as the request body. If you want more information, I recommend asking your own question. – Stephen Cleary Nov 21 '16 at 19:24
Thanks @StephenCleary. – Faith Wins Jan 09 '17 at 23:59

suulisin · Answer 3 · 2016-05-05T10:53:37.853

-5

The compiler will warn "Return statement missing". Please modify the code to:

 [HttpPost]
 [Route("AddApp")]
 public void AddApp([FromBody]Application app)
 {  
     //add configureAwait(false) as it would give better performance.

   loansRepository.InsertApplication(app)     
 }

edited May 05 '16 at 10:53

answered May 04 '16 at 23:29

suulisin

1,414
1
10
17

This is not an answer to his question, but a comment. Please don't use the answers section for this. – Leon Cullens May 05 '16 at 01:20
1

And your remark about ConfigureAwait is completely off. Please read a bit about what it actually does and why you would use it. – Leon Cullens May 05 '16 at 01:21
The usage of `async/await` add additional unneccessary overhead for no reason. Consider directly returning to `Task.Run` result. – Aron May 05 '16 at 01:29
My remarks about ConfigureAwait are very valid. Please read about it here [link](http://stackoverflow.com/questions/13489065/best-practice-to-call-configureawait-for-all-server-side-code/13494570#13494570). Also I have first hand information from Microsoft about it. – Soma Yarlagadda May 05 '16 at 01:32
Stephen Cleary's is the best approach since the repository call is synchronous. But, the question was about how to return void from the async method, I had to wrap it in Task.Run. Task.Run is not a recommended approach in asp.net applications as you are using a thread from the thread pool. – Soma Yarlagadda May 05 '16 at 01:45
how is it answer ? – Nazmul Hasan May 05 '16 at 09:54

How Return Void in Async Method in Web API

3 Answers3