How to add Web API to an existing ASP.NET MVC (5) Web Application project?

How to Add Web API to an existing ASP.NET MVC (5) Web Application project?

🔍 So, you forgot to tick the Web API checkbox when you created your shiny new MVC (5) project? Don't worry, we've got your back! In this blog post, we'll guide you through the steps to add Web API to your existing ASP.NET MVC (5) project and get it up and running. 💪

The Challenge

🤔 Adding Web API to an existing ASP.NET MVC (5) project can be a bit tricky, especially if you're looking for the most up-to-date steps. Many migration questions out there, but none seem to have the complete and accurate solution. 🚫

Old Answers won't work anymore

The solutions you'll find for adding Web API to an MVC 4 project might not work for MVC 5. Things have changed, my friend! So, let's focus on a solution that's specifically tailored for MVC 5. 📁

The Solution

💡 Follow these simple steps to add Web API to your existing ASP.NET MVC (5) project:

Step 1: Install the Required NuGet Packages

Open your Package Manager Console and run the following command to install the required packages:

Install-Package Microsoft.AspNet.WebApi -Version 5.2.6

This will install the necessary Web API package to your project.

Step 2: Configure Web API Routing

Open the App_Start folder in your project and locate the WebApiConfig.cs file. Add the following code:

using System.Web.Http;

namespace YourProjectNamespace
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // Web API routes
            config.MapHttpAttributeRoutes();

            config.Routes.MapHttpRoute(
                name: "DefaultApi",
                routeTemplate: "api/{controller}/{id}",
                defaults: new { id = RouteParameter.Optional }
            );
        }
    }
}

Step 3: Update Global.asax

Open the Global.asax.cs file and add the following code inside the Application_Start() method:

protected void Application_Start()
{
    // Other initialization code...

    // Web API configuration
    GlobalConfiguration.Configure(WebApiConfig.Register);

    // Other initialization code...
}

Step 4: Test Your Web API

Now that the Web API is added to your project, it's time to test it. Start your project, and in your browser, navigate to http://localhost:yourport/api/{controller}.

You should see the JSON representation of your data if everything is set up correctly. 🎉

Conclusion

🎉 Congrats! You have successfully added Web API to your existing ASP.NET MVC (5) project. Wasn't that easy-peasy? Now you can take advantage of the power of Web API in your application and build some awesome features. 🚀

👉 If you have any questions or encountered any issues, feel free to leave a comment below or reach out to us. We're here to help! 😊