Wrong API url in ASP.NET Core

Question

I have API controller in ASP.NET Core application as following.

[Route("api")]
public class UserController : Controller
{
    [HttpGet("{userName}/product_info")]
    public IActionResult GetProductInfo(string userName)
    {
        List<ProductInfo> productInfos = _repo.GetProductInfoByUserName(userName);
        if (productInfos.Count > 0)
            return Ok(productInfos);
        else
            return BadRequest("Unable to process requrest");
    }
}

I can call above API using /api/{username}/product_info. I have am using UseStatusCodePagesWithRedirects() to redirect to 404 page when user enters the wrong url. The problem here is that when I use wrong API url such as /api/{username}/product_o. It redirects to 404 page and returns status code of 200. I am using this API with angular.js. Since API returns 404 page on wrong URL with status code of 200, error function of then method of $http is never called and in response.data I get the HTML of 404 page. How do I return status code of 404 when wrong API URL is called and return normal 404 page when wrong NON API URL is called? Below is the screen shot of what I am getting when I call wrong API URL.

Based on @Daboul suggestion and solution on this link Adding following part in configure method of startup.cs works.

Func<HttpContext, bool> isApiRequest = (HttpContext context) => context.Request.Path.ToString().Contains("/api/");
app.UseWhen(context => !isApiRequest(context), appBuilder =>
{
     appBuilder.UseStatusCodePagesWithRedirects("~/Error/{0}");
});

Daboul · Accepted Answer · 2017-02-01 13:28:23Z

3

I believe that by using middlewares like UseStatusCodePages() or UseStatusCodePagesWithRedirects(), you are deciding to actually return a proper HTML page containing the error code (which require to send to the browser a code 200) instead of returning the code in itself. It's usually considered as a good practice in terms of security. What you are experiencing seems logical to me. Maybe, I'm not sure it would help in your case, what you could do is limit the usage of UseStatusCodePagesWithRedirects() to all the controllers but the api one using a UseWhen(), so that any wrong URL on this particular "/api/" controller would still returns 404? Or parse the answer in your angular to detect if any error occured.

edited Feb 1, 2017 at 13:28

answered Feb 1, 2017 at 13:20

Daboul

2,8131 gold badge21 silver badges31 bronze badges

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

4 Comments

Bhavesh Jadav Over a year ago

I am new to angular.js so I can not do much on the javascript side. On ASP.NET side what kind of middleware should I use to exclude API controller from using StatusCodePages? This problem also happens when I add Authorize attribute to the API controller. After adding Authorize attribute when I try to access API without signing in, It returns Login page with 200 status code. I had to remove Authorize attribute because of this.

Daboul Over a year ago

UseWhen() would do the job. You can find an example here for instance: stackoverflow.com/questions/37841270/… Using UseWhen() in conjonction with a condition on the URL context.Request.Path.StartsWithSegments("/API/")

Daboul Over a year ago

In your Update1 version

app.UseWhen(context => !isApiRequest(context), appBuilder =>         {             app.UseStatusCodePagesWithRedirects("~/Error/{0}");         });

should be

app.UseWhen(context => !isApiRequest(context), appBuilder =>         {             appBuilder.UseStatusCodePagesWithRedirects("~/Error/{0}");         });

switch app for appbuilder.

Daboul Over a year ago

No worries, in fact ion the internet you have a lots of tutorials with musage of UseWhen with the exact same confusion between app and appbuilder, I faced the issue. Thanks.

Collectives™ on Stack Overflow

Wrong API url in ASP.NET Core

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related