using Web Api in Webforms return 404 error

Question

I have an ASP.NET Webforms web site that includes Web API. The site is developed and tested with Visual Studio 2013 and .NET 4.5 on Windows 8 with IIS Express as web server.

I have added the Web Api controller in the root directory that is defined as follows:

[RoutePrefix("api")]
public class ProductsController : ApiController
{
    Product[] products = new Product[] 
    { 
        new Product { Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1 }, 
        new Product { Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M }, 
        new Product { Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M } 
    };
    [Route("ProductsController")]
    [HttpGet]
    public IEnumerable<Product> GetAllProducts()
    {
        return products;
    }

    public Product GetProductById(int id)
    {
        var product = products.FirstOrDefault((p) => p.Id == id);
        if (product == null)
        {
            throw new HttpResponseException(HttpStatusCode.NotFound);
        }
        return product;
    }

    public IEnumerable<Product> GetProductsByCategory(string category)
    {
        return products.Where(
            (p) => string.Equals(p.Category, category,
                StringComparison.OrdinalIgnoreCase));
    }
}

The Global.asax looks like this:

public class Global : HttpApplication
{
    void Application_Start(object sender, EventArgs e)
    {
        // Code that runs on application startup
        AreaRegistration.RegisterAllAreas();
        RouteConfig.RegisterRoutes(RouteTable.Routes);


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

    }
}

I have included these 2 lines in my web.config file

<validation validateIntegratedModeConfiguration="false"/>
<modules runAllManagedModulesForAllRequests="true"/>

When I make the get request with the following Url : http://localhost:5958/api/products, I get HTTP Error 404.0. I have tried different solutions but nothing works. Is there something that I'm missing? How do I rectify this problem?

Thanks in advance.

Community · Accepted Answer · 2017-05-23 11:59:33Z

2

You mixing up some of your convention-based and attribute routing for your web api.

Attribute Routing in ASP.NET Web API 2

If you are going to use attribute routing then you need to properly add the routes to your controller.

[RoutePrefix("api/products")]
public class ProductsController : ApiController
{
    //...code removed for brevity

    //eg: GET /api/products
    [HttpGet]
    [Route("")]
    public IEnumerable<Product> GetAllProducts(){...}

    //eg: GET /api/products/2
    [HttpGet]
    [Route("{id:int}")]
    public Product GetProductById(int id){...}

    //eg: GET /api/products/categories/Toys
    [HttpGet]
    [Route("categories/{category}")]
    public IEnumerable<Product> GetProductsByCategory(string category){...}
}

Now that you have your routes properly defined, you need to enable attribute routing.

WebApiConfig.cs

public static class WebApiConfig {
    public static void Register(HttpConfiguration config) {

        // Enable attribute routing
        config.MapHttpAttributeRoutes();

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

make sure to update the Global.asax code to the following:

public class Global : HttpApplication {
    void Application_Start(object sender, EventArgs e) {
        //ASP.NET WEB API CONFIG
        // Pass a delegate to the Configure method.
        GlobalConfiguration.Configure(WebApiConfig.Register);

        // Code that runs on application startup
        AreaRegistration.RegisterAllAreas();
        RouteConfig.RegisterRoutes(RouteTable.Routes);
    }
}

WebForm's RouteConfig

public static class RouteConfig
{
    public static void RegisterRoutes(RouteCollection routes)
    {
        var settings = new FriendlyUrlSettings();
        settings.AutoRedirectMode = RedirectMode.Permanent;
        routes.EnableFriendlyUrls(settings);
    }
}

resource:

Can you use the attribute-based routing of WebApi 2 with WebForms?.

edited May 23, 2017 at 11:59

CommunityBot

11 silver badge

answered Mar 27, 2016 at 12:09

Nkosi

249k38 gold badges472 silver badges506 bronze badges

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

5 Comments

Ahmed Mujtaba Over a year ago

Where should I add the controller class?

Nkosi Over a year ago

Doesn't really matter. Most people just create a folder called Controllers and place them there. Once the class is included in the project

Ahmed Mujtaba Over a year ago

It didn't work. I added all the attributes and updated the global.asax file. I created a new webforms project with Web api enabled. Web api controller works fine there. I'm thinking about copying all the files from tis project to that one.

Nkosi Over a year ago

You could do that as well. I see nothing wrong with that. I would suggest you look at the differences in the new project to your current one so you get an understanding as to what may be causing your issue. Happy coding.

Nkosi Over a year ago

take a look at the following answer to Can you use the attribute-based routing of WebApi 2 with WebForms?. I've updated my answer to include the additional info.

kranthiv · Accepted Answer · 2016-03-26 19:37:36Z

0

Based on your code,you didn't include routes for webapi. If you install Webapi from Nuget, you can find the WebApiConfig file under App_Start which contains the Route configuration for WebApi. If not create a new route config file for webapi

using System.Web.Http;
public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services

        // Web API routes
        config.MapHttpAttributeRoutes();

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

Use this static method in your Global.ascx.

using System.Web.Http;
 void Application_Start(object sender, EventArgs e)
    {

        GlobalConfiguration.Configure(WebApiConfig.Register);
        // Code that runs on application startup
        RouteConfig.RegisterRoutes(RouteTable.Routes);
        BundleConfig.RegisterBundles(BundleTable.Bundles);
    }

answered Mar 26, 2016 at 19:37

kranthiv

1741 gold badge1 silver badge8 bronze badges

1 Comment

Ahmed Mujtaba Over a year ago

I did all of that, still the same issue. Do I need to change anything in web.config?

Collectives™ on Stack Overflow

using Web Api in Webforms return 404 error

2 Answers 2

5 Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

5 Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related