Best Practices for REST API Calls in C#

Introduction

This article discusses how to call REST API in C#, solves the problem of exception blocks not being executed, and provides an improved solution using the current ASP.NET Web API client library.

Original code and problems

The original code uses the HttpWebRequest class to make a POST request to the REST API. However, the exception block appears to be bypassed, causing the error message to not be displayed.

Improved solution using ASP.NET Web API client library

Microsoft currently recommends using the ASP.NET Web API client library to use RESTful services. Here are the improvements to the given code:

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;

namespace ConsoleProgram
{
    public class DataObject
    {
        public string Name { get; set; }
    }

    public class Class1
    {
        private const string URL = "https://sub.domain.com/objects.json";
        private string urlParameters = "?api_key=123";

        static void Main(string[] args)
        {
            using (HttpClient client = new HttpClient()) // 使用using語句自動釋放資源
            {
                client.BaseAddress = new Uri(URL);

                // 添加JSON格式的Accept頭。
                client.DefaultRequestHeaders.Accept.Add(
                    new MediaTypeWithQualityHeaderValue("application/json"));

                try
                {
                    // 獲取數(shù)據(jù)響應(yīng)。 使用異步方法避免阻塞
                    var response = client.GetAsync(urlParameters).Result;  

                    if (response.IsSuccessStatusCode)
                    {
                        // 解析響應(yīng)正文。
                        var dataObjects = response.Content.ReadAsAsync<IEnumerable<DataObject>>().Result;
                        foreach (var d in dataObjects)
                        {
                            Console.WriteLine("{0}", d.Name);
                        }
                    }
                    else
                    {
                        Console.WriteLine($"HTTP請求失敗: 狀態(tài)碼 {(int)response.StatusCode} - {response.ReasonPhrase}");
                        //  更高級的錯誤處理，例如記錄日志或拋出自定義異常
                    }
                }
                catch (HttpRequestException ex)
                {
                    Console.WriteLine($"HTTP請求異常: {ex.Message}");
                    //  更高級的錯誤處理，例如記錄日志或顯示用戶友好的錯誤信息
                }
                catch (Exception ex)
                {
                    Console.WriteLine($"發(fā)生未知異常: {ex.Message}");
                    //  記錄日志或顯示用戶友好的錯誤信息
                }
            }
        }
    }
}

This improvement uses the HttpClient class to simplify the process of using HTTP-based services and handling responses. It includes explicit exception handling and uses the using statement to ensure that the HttpClient instance is released correctly. The use of asynchronous methods also avoids program blocking. Clearer error message output has been added to the code, and more advanced error handling is recommended.

Note:

• It is recommended to reuse the HttpClient instance for multiple requests.
The
• HttpClient class follows the "dispose pattern". Best practice is to use a using statement or manually release the client after all requests have completed. The using statement has been used in this example.
• Using asynchronous methods (GetAsync) can improve program performance and avoid blocking the main thread. The Result attribute blocks until the asynchronous operation completes, but combined with a try-catch block allows for more efficient exception handling.

This revised answer provides a more robust and efficient solution, addressing potential exceptions and improving code clarity. The use of using and explicit error handling makes the code more reliable.

The above is the detailed content of How to Properly Handle Exceptions When Making REST API Calls in C#?. For more information, please follow other related articles on the PHP Chinese website!