DNN Forums

Ask questions about your website to get help learning DNN and help resolve issues.
Prev
Next
Forums Development and Extensions DNN Platform API

Are async WebAPI methods supported?

 2 Replies
 2 Subscribed to this topic
 14 Subscribed to this forum
Sort:
Author
Messages
Henri
New Around Here
Posts:
New Around Here
11/8/2024 1:19 AM

    I know from the documentation that async MVC methods are not supported but I don't know whether that includes async WebAPI methods. I found a question on Stack Overflow (c# - What can cause an async webapi endpoint to act synchronously? - Stack Overflow) which seems to show that they work. I also did a little experiment of my own and they seem to work fine.

    So are async WebAPI methods supported? Is there a place in the official docs which says whether they are or aren't?

    2
    Brian Dukes
    Advanced Member
    Posts: 144
    Advanced Member
    11/11/2024 9:32 AM
      Async web API methods are supported, it's only the MVC rendering pipeline that doesn't support async actions. I don't believe that we have any documentation specifying that at the moment.

      Hope it helps!
      DNN partner specializing in custom, enterprise DNN development https://engagesoftware.com/showcase
      3
      Will Strohl
      Senior Member
      Posts: 1426
      Senior Member
      11/13/2024 4:02 PM

        We use async Web API endpoints all of the time.  As Brian says, it's not supported for the MVC implementation, specifically.  However, if you're using any SPA framework and need to have it communicate with your own Web API endpoints that are async, you'll be fine.  

        These Forums are dedicated to the discussion of DNN Platform.

        For the benefit of the community and to protect the integrity of the ecosystem, please observe the following posting guidelines:

        1. If you have (suspected) security issues, please DO NOT post them in the forums but instead follow the official DNN security policy. 
        2. No Advertising. This includes the promotion of commercial and non-commercial products or services which are not directly related to DNN.
        3. No vendor trolling / poaching. If someone posts about a vendor issue, allow the vendor or other customers to respond. Any post that looks like trolling / poaching will be removed.
        4. Discussion or promotion of DNN Platform product releases under a different brand name are strictly prohibited.
        5. No Flaming or Trolling.
        6. No Profanity, Racism, or Prejudice.
        7. Site Moderators have the final word on approving / removing a thread or post or comment.
        8. English language posting only, please.

        Would you like to help us?

        Awesome! Simply post in the forums using the link below and we'll get you started.

        Get Involved