Web Api controller returning 404 despite returning payload

Question

I have created a WebApi controller, and it's returning the payload OK (i.e. I see the correct response in the browser), however the status of the request is a 404, which obviously causes problems with JS clients.

Why is the status 404 when clearly the route exists?

I have even tried setting the response status explicitly:

return Request.CreateResponse(HttpStatusCode.OK, "hello");

But still get a 404?

I'm using Sitecore version 8.2 update 4.

Controller:

public class SearchApiController 
    : ApiController
{

    [HttpGet]
    public HttpResponseMessage Search()
    {
        var searchResults = GetSearchResults();

        return Request.CreateResponse(HttpStatusCode.OK, searchResults);
    }
}

Route mapping via pipeline:

public class InitializeRoutes
{
    public void Process(PipelineArgs args)
    {
        var config = GlobalConfiguration.Configuration;

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

Config:

    <pipelines>
        <initialize>
            <processor type="Feature.Search.Infrastructure.Pipelines.InitializeRoutes, Feature.Search" resolve="true" patch:before="processor[@type='Sitecore.Mvc.Pipelines.Loader.InitializeGlobalFilters, Sitecore.Mvc']" />
        </initialize>
    </pipelines>

Answer 1

It turned out that another member of the team had added a custom pipeline to handle 404's. It's code was checking the Sitecore.Context.Item and returning a 404 status if null, which obviously it would be when invoking the api url.

Answer 2

Change your code. The HttpResponseMessage is deprecated and is replaced by IHttpActionResult. While there are probably better and more Sitecore-esque ways to achieve what you are doing here, a straight up modification of your code would look like this:

public class SearchApiController 
    : ApiController
{

    [HttpGet]
    public IHttpActionResult Search()
    {
        var searchResults = GetSearchResults();
        if(searchResults == null)
            return NotFound();
        return Ok(searchResults);
    }
}

Reference: Web API Best Approach for returning HttpResponseMessage

Recommended followup reading: Implementing a WebApi service using ServicesApiController in Sitecore 8

Answer 3

You can try Web API attribute routing which in Sitecore 8.2 is supported with no conflicts with ​Sitecore.Services.Client.

You don't even need to configure Web API to use attribute routing configurations, all you need to add is to add the route prefixes to your you controllers/Action like this:

[RoutePrefix("api/searchapi")]
public class SearchApiController : ApiController
{
    [HttpGet]
    [Route("search")]
    public HttpResponseMessage Search()
    {
        var searchResults = GetSearchResults();

        return  Ok(searchResults);
    }
}

Answer 4

Can you please check http://{HostName}/sitecore/admin/showconfig.aspx and verify your pipeline processor position?

I would suggest to move it to the last position by applying Sitecore patch configuration or move it to zzz config folder.

We are having the same setup(Sitecore 8.2 update-4) except the case I mentioned above and everything works fine.

Answer 5

you can used SitecoreController like this and

then use api/{controller}/{action}/{id} or api/SearchApi/Search

public class SearchApiController 
    : SitecoreController 
{

    [HttpGet]
    public IHttpActionResult Search()
    {
        var searchResults = GetSearchResults();
        if(searchResults == null)
            return NotFound();
        return Ok(searchResults);
    }
}