Azure does not display custom error message for hosted .net core API

Question

I have the following API endpoint:

[AllowAnonymous]
    [HttpPost("login")]
    public async Task<IActionResult> Authenticate([FromBody] LoginViewModel credentials)
    {
        try
        {
            var result = await _facade.SomeMethodThatFailsAndThrowsCustomCode4001(credentials);
            return Ok(result);
        }
        catch (CustomException cEx)
        {
            return StatusCode(4001, new { Message = cEx.FriendlyMessage ?? "" }); //Message = Our custom user friendly message
        }
    }

When hosted on external server through IIS, these messages were returned perfectly. When hosted on Azure, the messages are not showing, and this is the response received:

{
  "Message": ""
}

I have read about Policies allowed in on-error, but this means I will need to register my .Net Core API with the API management in Azure, and not sure if this is necessary.

What would be required to be configured to allow our custom messages returned through our API hosted in Azure?

Is the status code 4001 as you return it? What happens if you hard code the message for example new { Message = "My test Message" }? — Nemanja Todorovic, Jan 27 '21 at 10:48
When you say, "hosted on Azure", can you clarify if you mean an Azure App Service? — tnk479, Jan 27 '21 at 14:34
@monstertjie_za You will alway get HttpStatus code 200, because you api `{yourController}/login` is a http request. — Jason Pan, Feb 01 '21 at 06:27
If my solution inspires or helps you, you mark my answer as [accepted](https://meta.stackexchange.com/questions/5234/how-does-accepting-an-answer-work) , Tks~ — Jason Pan, Feb 02 '21 at 02:20

score 1 · Accepted Answer · answered Feb 01 '21 at 07:08

You should read RFC doc about HTTP Status Codes.

1xx: Informational - Request received, continuing process

2xx: Success - The action was successfully received, understood, and accepted

3xx: Redirection - Further action must be taken in order to complete the request

4xx: Client Error - The request contains bad syntax or cannot be fulfilled

5xx: Server Error - The server failed to fulfill an apparently valid request

First, after testing, the upper limit of the usable range of StatusCode is 999. When StatusCode >999, errors will be reported all the time.

Second, you also can handle custom status code in Startup.cs.

if (env.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}
else
{
    app.UseHsts();
}
app.UseStatusCodePages(async context =>
{
    if (context.HttpContext.Response.StatusCode == 401)
    {
        await context.HttpContext.Response.WriteAsync("Custom Unauthorized request");
    }
});
//other middlewars

Azure does not display custom error message for hosted .net core API

1 Answers1

Related Post: