What is the best way to handle errors exception between application and an API?

Question

0.00/5 (No votes)

See more:

I understand that the API could be returning status codes like this:
200 - OK
400 - Bad Request
500 - Internal Server Error

Here is my code, how to handle the error from API in my controller?

C#

public ActionResult Get()
       {
       string token_access = User.Identity.GetAccessToken();
               Uri apiHistoryUri = new Uri(new Uri(ConfigurationManager.AppSettings["ida:ApiUri"]), "api/student/name");
               var client = new RestClient(apiHistoryUri);

               var request = new RestRequest(Method.GET);
               request.AddHeader("content-type", "application/x-www-form-urlencoded");
               request.AddHeader("cache-control", "no-cache");
               request.AddHeader("authorization", token_access);

               IRestResponse response = client.Execute(request);
               var content = response.Content;
               return View(content);
      }

The response from API can be anything, how to handle the exception here.

C#

IRestResponse response = client.Execute(request);
var content = response.Content;

What I have tried:

I tried to do this way, but im not sure.

IRestResponse response = client.Execute(request);
try
{
var content = response.Content;
return View(content);
}
catch {
throw (new Exception(res.StatusDescription.ToString()));
}

Posted 16-Aug-16 23:45pm

wa.war

Updated 13-Sep-21 9:42am

Add a Solution

Comments

njammy 17-Aug-16 6:13am

Why not just do
var statusCode = response.StatusCode;
and then handle it in a generic handler to build the appropriate response back to the client.

wa.war 18-Aug-16 0:08am

try{
//some code here

IRestResponse response= clt.Execute(req);
if (res.StatusCode.ToString().Equals("OK"))
{
var id = (string)JsonConvert.DeserializeObject(response.Content);
return Content("Fax Sent Successfully! - " + id);
}
else
{
throw (new HttpException(response.StatusDescription.ToString()));
}
catch (Exception ex)
{
return Content("Fail to send, please try again.");
}

** is this code acceptable?

Richard MacCutchan 17-Aug-16 6:38am

AFAIK those are status codes returned in the message, not exceptions. So you need to extract them from the response and check for the ones you can handle. Any that your code cannot deal with you just need to report to the user.

wa.war 17-Aug-16 22:45pm

I understand what do you mean, thanks. but the statuscode can be anything right? Not just 3 status that im mentions above. What is the best way to handle it and report back to user? can you give me an example?

Richard MacCutchan 18-Aug-16 3:21am

You only need to check for good status, and the ones that you can recover from in your code. For all the others you just post the full status message to the user and let them figure it out.

wa.war 18-Aug-16 3:41am

thanks for help Richard! :)

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Oscar Valdez · Answer 1 · 2021-09-13T09:42:00

C#

IRestResponse response = client.Execute(request);
if (response.StatusCode == System.Net.HttpStatusCode.OK)
{
	
}
else if (response.StatusCode == System.Net.HttpStatusCode.BadRequest)
{
	
}
else if (response.StatusCode == System.Net.HttpStatusCode.Unauthorized)
{
	
}
else
{
	throw new Exception(string.Format("No se puede consumir el API: {0}", response.ErrorException));
}