ฉันจะโทรหา REST api โดยใช้ C # ได้อย่างไร


335

นี่คือรหัสที่ฉันมี:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System;
using System.Net.Http;
using System.Web;
using System.Net;
using System.IO;

namespace ConsoleProgram
{
    public class Class1
    {
        private const string URL = "https://sub.domain.com/objects.json?api_key=123";
        private const string DATA = @"{""object"":{""name"":""Name""}}";

        static void Main(string[] args)
        {
            Class1.CreateObject();
        }

        private static void CreateObject()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);
            request.Method = "POST";
            request.ContentType = "application/json"; 
            request.ContentLength = DATA.Length;
            StreamWriter requestWriter = new StreamWriter(request.GetRequestStream(), System.Text.Encoding.ASCII);
            requestWriter.Write(DATA);
            requestWriter.Close();

             try {
                WebResponse webResponse = request.GetResponse();
                Stream webStream = webResponse.GetResponseStream();
                StreamReader responseReader = new StreamReader(webStream);
                string response = responseReader.ReadToEnd();
                Console.Out.WriteLine(response);
                responseReader.Close();
            } catch (Exception e) {
                Console.Out.WriteLine("-----------------");
                Console.Out.WriteLine(e.Message);
            }

        }
    }
}

ปัญหาคือฉันคิดว่ามีการทริกเกอร์บล็อกข้อยกเว้น (เพราะเมื่อฉันลบ try-catch ฉันได้รับข้อความข้อผิดพลาดเซิร์ฟเวอร์ (500) แต่ฉันไม่เห็นบรรทัด Console.Out ที่ฉันใส่ในบล็อก catch

คอนโซลของฉัน:

The thread 'vshost.NotifyLoad' (0x1a20) has exited with code 0 (0x0).
The thread '<No Name>' (0x1988) has exited with code 0 (0x0).
The thread 'vshost.LoadReference' (0x1710) has exited with code 0 (0x0).
'ConsoleApplication1.vshost.exe' (Managed (v4.0.30319)): Loaded 'c:\users\l. preston sego iii\documents\visual studio 11\Projects\ConsoleApplication1\ConsoleApplication1\bin\Debug\ConsoleApplication1.exe', Symbols loaded.
'ConsoleApplication1.vshost.exe' (Managed (v4.0.30319)): Loaded 'C:\Windows\Microsoft.Net\assembly\GAC_MSIL\System.Configuration\v4.0_4.0.0.0__b03f5f7f11d50a3a\System.Configuration.dll', Skipped loading symbols. Module is optimized and the debugger option 'Just My Code' is enabled.
A first chance exception of type 'System.Net.WebException' occurred in System.dll
The thread 'vshost.RunParkingWindow' (0x184c) has exited with code 0 (0x0).
The thread '<No Name>' (0x1810) has exited with code 0 (0x0).
The program '[2780] ConsoleApplication1.vshost.exe: Program Trace' has exited with code 0 (0x0).
The program '[2780] ConsoleApplication1.vshost.exe: Managed (v4.0.30319)' has exited with code 0 (0x0).

ฉันใช้ Visual Studio 2011 Beta และ .NET 4.5 Beta


นอกจากนี้คุณได้ใส่จุดพักไว้เพื่อดูว่ามันระเบิดขึ้นหรือไม่?
NotMe

นี่เป็นผลมาจากหน้าต่างเอาต์พุต แต่ไม่ใช่คอนโซล
Serj-Tm

5
MSDN มีบทความที่ยอดเยี่ยมเกี่ยวกับการสร้างบริการ RESTful: msdn.microsoft.com/library/dd203052.aspx ... และไคลเอนต์ RESTful: msdn.microsoft.com/en-us/magazine/ee309509.aspx
Lynn Crumbling

@ChrisLively สิ่งนี้เกี่ยวข้องกับ IE หรือไม่ = \ มันเป็นการระเบิดตามคำขอ GetResponse line
NullVoxPopuli

@TheLindyHop; ไม่มีอะไรจริงๆ. ฉันอ่านผิด
NotMe

คำตอบ:


427

ASP.Net Web API ได้แทนที่ WCF Web API ที่กล่าวถึงก่อนหน้านี้

ฉันคิดว่าฉันโพสต์คำตอบที่อัปเดตแล้วเนื่องจากคำตอบส่วนใหญ่มาจากต้นปี 2012 และหัวข้อนี้เป็นหนึ่งในผลลัพธ์อันดับต้น ๆ เมื่อทำการค้นหาโดย Google สำหรับ "call restful service c #"

คำแนะนำปัจจุบันจาก Microsoft คือการใช้ไลบรารีไคลเอนต์ Microsoft ASP.NET Web API เพื่อใช้บริการ RESTful สิ่งนี้มีให้เป็นแพ็คเกจ NuGet, Microsoft.AspNet.WebApi.Client คุณจะต้องเพิ่มแพ็คเกจ NuGet นี้ลงในโซลูชันของคุณ

นี่คือตัวอย่างของคุณเมื่อใช้งานโดยใช้ไลบรารีไคลเอนต์ ASP.Net Web API:

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)
        {
            HttpClient client = new HttpClient();
            client.BaseAddress = new Uri(URL);

            // Add an Accept header for JSON format.
            client.DefaultRequestHeaders.Accept.Add(
            new MediaTypeWithQualityHeaderValue("application/json"));

            // List data response.
            HttpResponseMessage response = client.GetAsync(urlParameters).Result;  // Blocking call! Program will wait here until a response is received or a timeout occurs.
            if (response.IsSuccessStatusCode)
            {
                // Parse the response body.
                var dataObjects = response.Content.ReadAsAsync<IEnumerable<DataObject>>().Result;  //Make sure to add a reference to System.Net.Http.Formatting.dll
                foreach (var d in dataObjects)
                {
                    Console.WriteLine("{0}", d.Name);
                }
            }
            else
            {
                Console.WriteLine("{0} ({1})", (int)response.StatusCode, response.ReasonPhrase);
            }

            //Make any other calls using HttpClient here.

            //Dispose once all HttpClient calls are complete. This is not necessary if the containing object will be disposed of; for example in this case the HttpClient instance will be disposed automatically when the application terminates so the following call is superfluous.
            client.Dispose();
        }
    }
}

หากคุณวางแผนที่จะทำหลายคำขอคุณควรใช้อินสแตนซ์ HttpClient ของคุณอีกครั้ง ดูคำถามนี้และคำตอบสำหรับรายละเอียดเพิ่มเติมว่าทำไมคำสั่งการใช้ไม่ได้ถูกใช้กับอินสแตนซ์ HttpClient ในกรณีนี้: ต้องยกเลิก HttpClient และ HttpClientHandler หรือไม่

สำหรับรายละเอียดเพิ่มเติมรวมถึงตัวอย่างอื่น ๆ ไปที่: http://www.asp.net/web-api/overview/web-api-clients/calling-a-web-api-from-a-net-client

โพสต์บล็อกนี้อาจมีประโยชน์: http://johnnycode.com/2012/02/23/consuming-your-own-asp-net-we-web-api-rest-service/


6
ขอบคุณ! ฉันต้องการติดตั้งแพคเกจ NuGet สำหรับลูกค้า WebApi เพื่อให้ใช้งานได้สำหรับฉัน: Install-Package Microsoft.AspNet.WebApi.Client
Ev.

3
หากคุณต้องการเยาะเย้ยบูรณาการส่วนที่เหลือของคุณแม้จะมีห้องสมุดลูกค้าก็ยังคงไม่ใช่เรื่องง่าย ลอง RestSharp?
โบสถ์ Rob

6
เพื่อให้คำตอบนี้ดียิ่งขึ้นกว่ามันแล้วคือคุณควรห่อประกาศ HttpClient เป็นงบใช้ดีในการจัดการทรัพยากรของคุณ :)
แดเนียลเบิร์ท

7
พยายามที่จะใช้ แต่ไม่สามารถใช้ ReadAsAsync () ได้รับข้อผิดพลาด "HttpContent ไม่มีคำจำกัดความของ 'ReadAsAsync' และไม่มีวิธีการขยาย
Robert Green MBA

7
@RobertGreenMBA: เพื่อให้ได้วิธีการขยายเพิ่มการอ้างอิงถึงReadAsAsync() System.Net.Http.Formatting.dll(เข้าใจง่ายใช่มั้ย)
Arin

122

คำแนะนำของฉันจะใช้RestSharp คุณสามารถโทรไปยังบริการ REST และให้พวกเขาส่งไปยังวัตถุ POCO ด้วยรหัสสำเร็จรูปน้อยมากที่จะต้องแยกวิเคราะห์ผ่านการตอบสนอง สิ่งนี้จะไม่แก้ไขข้อผิดพลาดเฉพาะของคุณ แต่ตอบคำถามโดยรวมของคุณเกี่ยวกับวิธีการโทรไปยังบริการ REST ต้องเปลี่ยนรหัสของคุณเพื่อใช้มันควรจะจ่ายในการใช้งานง่ายและความทนทานต่อไปข้างหน้า นั่นเป็นเพียง 2 เซ็นต์ของฉัน

ตัวอย่าง:

namespace RestSharpThingy
{
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using System.Net;
    using System.Reflection;

    using RestSharp;

    public static class Program
    {
        public static void Main()
        {
            Uri baseUrl = new Uri("https://httpbin.org/");
            IRestClient client = new RestClient(baseUrl);
            IRestRequest request = new RestRequest("get", Method.GET) { Credentials = new NetworkCredential("testUser", "P455w0rd") };

            request.AddHeader("Authorization", "Bearer qaPmk9Vw8o7r7UOiX-3b-8Z_6r3w0Iu2pecwJ3x7CngjPp2fN3c61Q_5VU3y0rc-vPpkTKuaOI2eRs3bMyA5ucKKzY1thMFoM0wjnReEYeMGyq3JfZ-OIko1if3NmIj79ZSpNotLL2734ts2jGBjw8-uUgKet7jQAaq-qf5aIDwzUo0bnGosEj_UkFxiJKXPPlF2L4iNJSlBqRYrhw08RK1SzB4tf18Airb80WVy1Kewx2NGq5zCC-SCzvJW-mlOtjIDBAQ5intqaRkwRaSyjJ_MagxJF_CLc4BNUYC3hC2ejQDoTE6HYMWMcg0mbyWghMFpOw3gqyfAGjr6LPJcIly__aJ5__iyt-BTkOnMpDAZLTjzx4qDHMPWeND-TlzKWXjVb5yMv5Q6Jg6UmETWbuxyTdvGTJFzanUg1HWzPr7gSs6GLEv9VDTMiC8a5sNcGyLcHBIJo8mErrZrIssHvbT8ZUPWtyJaujKvdgazqsrad9CO3iRsZWQJ3lpvdQwucCsyjoRVoj_mXYhz3JK3wfOjLff16Gy1NLbj4gmOhBBRb8rJnUXnP7rBHs00FAk59BIpKLIPIyMgYBApDCut8V55AgXtGs4MgFFiJKbuaKxq8cdMYEVBTzDJ-S1IR5d6eiTGusD5aFlUkAs9NV_nFw");
            request.AddParameter("clientId", 123);

            IRestResponse<RootObject> response = client.Execute<RootObject>(request);

            if (response.IsSuccessful)
            {
                response.Data.Write();
            }
            else
            {
                Console.WriteLine(response.ErrorMessage);
            }

            Console.WriteLine();

            string path = Assembly.GetExecutingAssembly().Location;
            string name = Path.GetFileName(path);

            request = new RestRequest("post", Method.POST);
            request.AddFile(name, File.ReadAllBytes(path), name, "application/octet-stream");
            response = client.Execute<RootObject>(request);
            if (response.IsSuccessful)
            {
                response.Data.Write();
            }
            else
            {
                Console.WriteLine(response.ErrorMessage);
            }

            Console.ReadLine();
        }

        private static void Write(this RootObject rootObject)
        {
            Console.WriteLine("clientId: " + rootObject.args.clientId);
            Console.WriteLine("Accept: " + rootObject.headers.Accept);
            Console.WriteLine("AcceptEncoding: " + rootObject.headers.AcceptEncoding);
            Console.WriteLine("AcceptLanguage: " + rootObject.headers.AcceptLanguage);
            Console.WriteLine("Authorization: " + rootObject.headers.Authorization);
            Console.WriteLine("Connection: " + rootObject.headers.Connection);
            Console.WriteLine("Dnt: " + rootObject.headers.Dnt);
            Console.WriteLine("Host: " + rootObject.headers.Host);
            Console.WriteLine("Origin: " + rootObject.headers.Origin);
            Console.WriteLine("Referer: " + rootObject.headers.Referer);
            Console.WriteLine("UserAgent: " + rootObject.headers.UserAgent);
            Console.WriteLine("origin: " + rootObject.origin);
            Console.WriteLine("url: " + rootObject.url);
            Console.WriteLine("data: " + rootObject.data);
            Console.WriteLine("files: ");
            foreach (KeyValuePair<string, string> kvp in rootObject.files ?? Enumerable.Empty<KeyValuePair<string, string>>())
            {
                Console.WriteLine("\t" + kvp.Key + ": " + kvp.Value);
            }
        }
    }

    public class Args
    {
        public string clientId { get; set; }
    }

    public class Headers
    {
        public string Accept { get; set; }

        public string AcceptEncoding { get; set; }

        public string AcceptLanguage { get; set; }

        public string Authorization { get; set; }

        public string Connection { get; set; }

        public string Dnt { get; set; }

        public string Host { get; set; }

        public string Origin { get; set; }

        public string Referer { get; set; }

        public string UserAgent { get; set; }
    }

    public class RootObject
    {
        public Args args { get; set; }

        public Headers headers { get; set; }

        public string origin { get; set; }

        public string url { get; set; }

        public string data { get; set; }

        public Dictionary<string, string> files { get; set; }
    }
}

6
RestSharp และ JSON.NET เป็นวิธีที่จะไปอย่างแน่นอน ฉันพบชุดเครื่องมือ MS ขาดและมีแนวโน้มที่จะล้มเหลว
cbuteau

2
การลงคะแนนเสียงอีกครั้งสำหรับ RestSharp เนื่องจากคุณสามารถเยาะเย้ยออกมาทดสอบได้ง่ายกว่า WebApi Client ไลบรารีมาก
Rob Church

1
สำหรับผู้ใช้โมโน - RestSharp ดูเหมือนว่าจะใช้ System.Net WebRequest apis ซึ่งในประสบการณ์ของฉันไม่น่าเชื่อถือเท่ากับการใช้งาน. net ('สุ่ม' แฮงค์)
Tom

3
มันคงจะดีถ้ามีตัวอย่างในคำตอบนี้
Caltor

2
การขาดตัวอย่างทำให้โพสต์นี้ไม่เป็นประโยชน์!
smac2020

39

ไม่เกี่ยวข้องฉันแน่ใจ แต่ห่อIDisposableวัตถุของคุณเป็นusingบล็อกเพื่อให้แน่ใจว่ามีการกำจัดอย่างถูกต้อง:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System;
using System.Web;
using System.Net;
using System.IO;

namespace ConsoleProgram
{
    public class Class1
    {
        private const string URL = "https://sub.domain.com/objects.json?api_key=123";
        private const string DATA = @"{""object"":{""name"":""Name""}}";

        static void Main(string[] args)
        {
            Class1.CreateObject();
        }

        private static void CreateObject()
        {
            HttpWebRequest request = (HttpWebRequest)WebRequest.Create(URL);
            request.Method = "POST";
            request.ContentType = "application/json";
            request.ContentLength = DATA.Length;
            using (Stream webStream = request.GetRequestStream())
            using (StreamWriter requestWriter = new StreamWriter(webStream, System.Text.Encoding.ASCII))
            {
                requestWriter.Write(DATA);
            }

            try
            {
                WebResponse webResponse = request.GetResponse();
                using (Stream webStream = webResponse.GetResponseStream() ?? Stream.Null)
                using (StreamReader responseReader = new StreamReader(webStream))
                {
                    string response = responseReader.ReadToEnd();
                    Console.Out.WriteLine(response);
                }
            }
            catch (Exception e)
            {
                Console.Out.WriteLine("-----------------");
                Console.Out.WriteLine(e.Message);
            }

        }
    }
}

4
คำตอบที่ดีซึ่งไม่ได้ใช้แพ็กเกจพิเศษนอกเหนือจากสภาพแวดล้อม. NET ปกติ
palswim

@Jesse C. เครื่องตัด .. ทำไมฉันถึงเกิดข้อผิดพลาด 404 ใน WebResponse webResponse = request.GetResponse ();
Goh Han

2
เนื่องจากไม่พบทรัพยากร มีหลายเหตุผลที่จะได้รับ 404
Jesse C. Slicer

1
นี่เป็นทางออกที่ยอดเยี่ยม @ JesseC.Slicer ฉันสามารถใช้รหัสนี้เพื่อดึงโทเค็นและดูจากคอนโซล คุณมีคำแนะนำใด ๆ หรือไม่ที่ฉันจะต้องนำโทเค็นนี้ไปใช้สำหรับการตรวจสอบสิทธิ์ / การเข้าสู่ระบบในตอนนี้ ฉันต้องการใช้ GET เพื่อดึงข้อมูลบางอย่าง แต่ทำได้เฉพาะเมื่อฉันลงชื่อเข้าใช้ฉันจะเรียนรู้เพิ่มเติมเกี่ยวกับเรื่องนี้ได้ที่ไหน ขอบคุณ!
พอลลากูน่า

18

ต่อไปนี้เป็นวิธีที่แตกต่างกันสองสามวิธีในการโทรหา API ภายนอกใน C # (อัปเดต 2019)

. วิธีการในตัวของ. NET:

  • WebRequest & WebClient - API ของ verbose และเอกสารของ Microsoft นั้นไม่ง่ายมากที่จะติดตาม
  • HttpClient - เด็กใหม่ล่าสุดของ. NET ในบล็อกและใช้งานง่ายกว่าที่กล่าวมาข้างต้น

NuGet Packages โอเพ่นซอร์สฟรีซึ่งตรงไปตรงมามีประสบการณ์นักพัฒนาที่ดีกว่าของ. NET ที่มีอยู่ในไคลเอ็นต์:

  • ServiceStack.Text (1k github stars, 7m Nuget download) (*) - รวดเร็วเบาและยืดหยุ่น
  • RestSharp (6k github stars, 23m Nuget Downloads) (*) - ไคลเอนต์ REST และ HTTP API อย่างง่าย
  • Flurl (1.7k github stars, 3m Nuget Downloads) (*) - คลังไคลเอ็นต์ HTTP ที่คล่องแคล่วพกพาทดสอบได้

แพคเกจทั้งหมดข้างต้นให้ประสบการณ์นักพัฒนาที่ยอดเยี่ยม (เช่นกระชับง่าย API) และได้รับการดูแลอย่างดี

(*)ณ วันที่สิงหาคม 2562

ตัวอย่าง: การรับไอเท็มสิ่งที่ต้องทำจาก Fake Rest API โดยใช้ ServiceStack.Text ไลบรารีอื่นมีไวยากรณ์คล้ายกันมาก

class Program
{
    static void Main(string[] args)
    {
        // fake rest API
        string url = "https://jsonplaceholder.typicode.com/todos/1";

        // GET data from api & map to Poco
        var todo =  url.GetJsonFromUrl().FromJson<Todo>();

        // print result to screen
        todo.PrintDump();
    }
    public class Todo
    {
        public int UserId { get; set; }
        public int Id { get; set; }
        public string Title { get; set; }
        public bool Completed { get; set; }
    }

}

การรันตัวอย่างข้างต้นในแอป. NET Core Console จะสร้างเอาต์พุตต่อไปนี้

ป้อนคำอธิบายรูปภาพที่นี่

ติดตั้งแพ็คเกจเหล่านี้โดยใช้ NuGet

Install-Package ServiceStack.Text, or

Install-Package RestSharp, or

Install-Package Flurl.Http

17

โปรดใช้รหัสด้านล่างสำหรับคำขอ REST api ของคุณ

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Json;

namespace ConsoleApplication2
{
    class Program
    {
        private const string URL = "https://XXXX/rest/api/2/component";
        private const string DATA = @"{
    ""name"": ""Component 2"",
    ""description"": ""This is a JIRA component"",
    ""leadUserName"": ""xx"",
    ""assigneeType"": ""PROJECT_LEAD"",
    ""isAssigneeTypeValid"": false,
    ""project"": ""TP""}";

        static void Main(string[] args)
        {
            AddComponent();
        }

        private static void AddComponent()
        {
            System.Net.Http.HttpClient client = new System.Net.Http.HttpClient();
            client.BaseAddress = new System.Uri(URL);
            byte[] cred = UTF8Encoding.UTF8.GetBytes("username:password");
            client.DefaultRequestHeaders.Authorization = new System.Net.Http.Headers.AuthenticationHeaderValue("Basic", Convert.ToBase64String(cred));
            client.DefaultRequestHeaders.Accept.Add(new System.Net.Http.Headers.MediaTypeWithQualityHeaderValue("application/json"));

            System.Net.Http.HttpContent content = new StringContent(DATA, UTF8Encoding.UTF8, "application/json");
            HttpResponseMessage messge = client.PostAsync(URL, content).Result;
            string description = string.Empty;
            if (messge.IsSuccessStatusCode)
            {
                string result = messge.Content.ReadAsStringAsync().Result;
                description = result;
            }
        }
    }
}

-1: .net เป็นแพลตฟอร์มที่มีการจัดการ แต่ HttpClient ไม่มีการจัดการ (หมายถึงคุณต้องใช้เพื่อบอกเมื่อมันสามารถกำจัดพอยน์เตอร์ที่ไม่ได้รับการจัดการเหล่านั้นได้) หากไม่มีรหัสของคุณจะไม่ขยายไปถึงผู้ใช้สองคน (และใช่นี่คือสิ่งสำคัญดังนั้นสิ่งสำคัญคือภาษานั้นมีคำหลักที่เฉพาะเจาะจงในการจัดการกับมัน)
JCKödel

5
@ JCKödel - คุณไม่ได้อยู่ที่นี่อย่างแน่นอนและควรอ่านstackoverflow.com/a/22561368 - HttpClient ได้รับการออกแบบมาให้ใช้ซ้ำสำหรับการโทรหลายสาย
hB0

1
ใช่ @ JCKödelโปรดอ่านบทความนี้stackoverflow.com/questions/15705092/…
นาธาน

11

ฉันต้องการแบ่งปันโซลูชันของฉันใน ASP.NET Core

using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;
using System.Configuration;

namespace WebApp
{
    public static class HttpHelper
    {
        // In my case this is https://localhost:44366/
        private static readonly string apiBasicUri = ConfigurationManager.AppSettings["apiBasicUri"];

        public static async Task Post<T>(string url, T contentValue)
        {
            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri(apiBasicUri);
                var content = new StringContent(JsonConvert.SerializeObject(contentValue), Encoding.UTF8, "application/json");
                var result = await client.PostAsync(url, content);
                result.EnsureSuccessStatusCode();
            }
        }

        public static async Task Put<T>(string url, T stringValue)
        {
            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri(apiBasicUri);
                var content = new StringContent(JsonConvert.SerializeObject(stringValue), Encoding.UTF8, "application/json");
                var result = await client.PutAsync(url, content);
                result.EnsureSuccessStatusCode();
            }
        }

        public static async Task<T> Get<T>(string url)
        {
            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri(apiBasicUri);
                var result = await client.GetAsync(url);
                result.EnsureSuccessStatusCode();
                string resultContentString = await result.Content.ReadAsStringAsync();
                T resultContent = JsonConvert.DeserializeObject<T>(resultContentString);
                return resultContent;
            }
        }

        public static async Task Delete(string url)
        {
            using (var client = new HttpClient())
            {
                client.BaseAddress = new Uri(apiBasicUri);
                var result = await client.DeleteAsync(url);
                result.EnsureSuccessStatusCode();
            }
        }
    }
}

ในการโพสต์ใช้สิ่งนี้:

await HttpHelper.Post<Setting>($"/api/values/{id}", setting);

ตัวอย่างสำหรับการลบ:

await HttpHelper.Delete($"/api/values/{id}");

ตัวอย่างเพื่อรับรายการ:

List<ClaimTerm> claimTerms = await HttpHelper.Get<List<ClaimTerm>>("/api/values/");

ตัวอย่างเพื่อรับเพียงหนึ่ง:

ClaimTerm processedClaimImage = await HttpHelper.Get<ClaimTerm>($"/api/values/{id}");

2
นั่นเป็นรหัสที่ดีมากถึงแม้ว่าคุณไม่ควรใช้ httpclient ภายในบล็อคที่ใช้ ดูaspnetmonsters.com/2016/08/2016-08-27-httpclientwrong
Myke Black

9

อัพเดตสำหรับการเรียกใช้ REST API เมื่อใช้. NET 4.5 หรือ. NET Core

ฉันจะแนะนำDalSoft.RestClient (caveat ฉันสร้างมันขึ้นมา) เหตุผลเนื่องจากใช้การพิมพ์แบบไดนามิกคุณสามารถรวมทุกอย่างไว้ในการโทรได้อย่างคล่องแคล่วรวมถึงการทำให้เป็นอนุกรม / การทำให้เป็นอนุกรม ด้านล่างเป็นตัวอย่าง PUT ที่ใช้งานได้:

dynamic client = new RestClient("http://jsonplaceholder.typicode.com");

var post = new Post { title = "foo", body = "bar", userId = 10 };

var result = await client.Posts(1).Put(post);

5

ได้รับ:

// GET JSON Response
public WeatherResponseModel GET(string url) {
    WeatherResponseModel model = new WeatherResponseModel();
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
    try {
        WebResponse response = request.GetResponse();
        using(Stream responseStream = response.GetResponseStream()) {
            StreamReader reader = new StreamReader(responseStream, Encoding.UTF8);
            model = JsonConvert.DeserializeObject < WeatherResponseModel > (reader.ReadToEnd());
        }
    } catch (WebException ex) {
        WebResponse errorResponse = ex.Response;
        using(Stream responseStream = errorResponse.GetResponseStream()) {
            StreamReader reader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            String errorText = reader.ReadToEnd();
            // log errorText
        }
        throw;
    }

    return model;
}

โพสต์:

// POST a JSON string
void POST(string url, string jsonContent) {
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(url);
    request.Method = "POST";

    System.Text.UTF8Encoding encoding = new System.Text.UTF8Encoding();
    Byte[]byteArray = encoding.GetBytes(jsonContent);

    request.ContentLength = byteArray.Length;
    request.ContentType =  @ "application/json";

    using(Stream dataStream = request.GetRequestStream()) {
        dataStream.Write(byteArray, 0, byteArray.Length);
    }
    long length = 0;
    try {
        using(HttpWebResponse response = (HttpWebResponse)request.GetResponse()) {
            // got response
            length = response.ContentLength;
        }
    } catch (WebException ex) {
        WebResponse errorResponse = ex.Response;
        using(Stream responseStream = errorResponse.GetResponseStream()) {
            StreamReader reader = new StreamReader(responseStream, Encoding.GetEncoding("utf-8"));
            String errorText = reader.ReadToEnd();
            // log errorText
        }
        throw;
    }
}

หมายเหตุ: ในการทำให้เป็นอนุกรมและ desirialze JSON ฉันใช้แพ็คเกจ Newtonsoft.Json NuGet


4

ตรวจสอบอานิสงส์สำหรับการโทรไปยังบริการที่เหลือจาก. ฉันพบว่าใช้งานง่ายมาก: https://github.com/paulcbetts/refit

อานิสงส์: ไลบรารี REST ชนิดปลอดภัยโดยอัตโนมัติสำหรับ. NET Core, Xamarin และ. NET

Refit เป็นไลบรารีที่ได้รับแรงบันดาลใจอย่างมากจาก Retrofit ของ Square และจะเปลี่ยน REST API ของคุณให้กลายเป็นอินเตอร์เฟสสด:

public interface IGitHubApi {
        [Get("/users/{user}")]
        Task<User> GetUser(string user); } The RestService class generates an implementation of IGitHubApi that uses HttpClient to make its calls:

var gitHubApi = RestService.For<IGitHubApi>("https://api.github.com");

var octocat = await gitHubApi.GetUser("octocat");

คุณรู้หรือไม่ถ้าอานิสงส์ใช้การสะท้อนเพื่อให้บรรลุนี้ ฉันไม่สามารถหาข้อมูลได้ทุกที่
tfrascaroli

ขอโทษ @tfrascaroli ฉันไม่แน่ใจว่ามือ
patrickbadley

2

นี่คือตัวอย่างรหัสที่ใช้งานได้อย่างแน่นอน ฉันใช้เวลาหนึ่งวันในการทำให้สิ่งนี้อ่านชุดของวัตถุจากบริการส่วนที่เหลือ:

RootObject เป็นชนิดของอ๊อบเจค Im ที่อ่านจากเซอร์วิสที่เหลือ

string url = @"http://restcountries.eu/rest/v1";
DataContractJsonSerializer serializer = new DataContractJsonSerializer(typeof(IEnumerable<RootObject>));
WebClient syncClient = new WebClient();
string content = syncClient.DownloadString(url);

using (MemoryStream memo = new MemoryStream(Encoding.Unicode.GetBytes(content)))
{
    IEnumerable<RootObject> countries = (IEnumerable<RootObject>)serializer.ReadObject(memo);    
}

Console.Read();

1
    var TakingRequset = WebRequest.Create("http://xxx.acv.com/MethodName/Get");
    TakingRequset.Method = "POST";
    TakingRequset.ContentType = "text/xml;charset=utf-8";
    TakingRequset.PreAuthenticate = true;

    //---Serving Request path query
     var PAQ = TakingRequset.RequestUri.PathAndQuery;

    //---creating your xml as per the host reqirement
    string xmlroot=@"<root><childnodes>passing parameters</childnodes></root>";
    string xmlroot2=@"<root><childnodes>passing parameters</childnodes></root>";

    //---Adding Headers as requested by host 
    xmlroot2 = (xmlroot2 + "XXX---");
    //---Adding Headers Value as requested by host 
  //  var RequestheaderVales = Method(xmlroot2);

    WebProxy proxy = new WebProxy("XXXXX-----llll", 8080);
    proxy.Credentials = new NetworkCredential("XXX---uuuu", "XXX----", "XXXX----");
    System.Net.WebRequest.DefaultWebProxy = proxy;


    // Adding The Request into Headers
    TakingRequset.Headers.Add("xxx", "Any Request Variable ");
    TakingRequset.Headers.Add("xxx", "Any Request Variable");

    byte[] byteData = Encoding.UTF8.GetBytes(xmlroot);
    TakingRequset.ContentLength = byteData.Length;

    using (Stream postStream = TakingRequset.GetRequestStream())
    {
        postStream.Write(byteData, 0, byteData.Length);
        postStream.Close();
    }



    StreamReader stredr = new StreamReader(TakingRequset.GetResponse().GetResponseStream());
    string response = stredr.ReadToEnd();

1

ฉันทำได้ด้วยวิธีง่ายๆนี้กับเว็บ Api 2.0 คุณสามารถลบ UseDefaultCredentials.I ที่ใช้สำหรับกรณีการใช้งานของฉันเอง

            List<YourObject> listObjects = new List<YourObject>();


            string response = "";
            using (var client = new WebClient() { UseDefaultCredentials = true })
            {
                 response = client.DownloadString(apiUrl);
            }

            listObjects = JsonConvert.DeserializeObject<List<YourObject>>(response);
            return listObjects ;


0

คำตอบที่ทำเครื่องหมายไว้ที่นี่แนะนำให้ใช้ HttpClient โดยตรงและการกำจัดมัน สิ่งนี้อาจใช้งานได้ แต่เป็นเรื่องง่ายที่จะพบปัญหาเกี่ยวกับ HttpClient หากคุณใช้ไม่ถูกต้อง หากคุณกำลังจะใช้ HttpClient คุณควรส่งการสร้าง / กำจัด HttpClients ไปยังห้องสมุดบุคคลที่สามที่ใช้รูปแบบจากโรงงาน RestClient.Netเป็นหนึ่งในห้องสมุดดังกล่าว

มันมาพร้อมกับโรงงาน HttpClient ที่ธรรมดามาก ๆ เพื่อที่คุณจะได้ไม่ต้องเจอกับปัญหาความอ่อนล้าของซ็อกเก็ต

public class DefaultHttpClientFactory : IHttpClientFactory, IDisposable
{
    #region Fields
    private bool disposed;
    private readonly ConcurrentDictionary<string, Lazy<HttpClient>> _httpClients;
    private readonly Func<string, Lazy<HttpClient>> _createClientFunc;
    #endregion

    #region Constructor
    public DefaultHttpClientFactory() : this(null)
    {
    }

    public DefaultHttpClientFactory(Func<string, Lazy<HttpClient>> createClientFunc)
    {
        _createClientFunc = createClientFunc;
        _httpClients = new ConcurrentDictionary<string, Lazy<HttpClient>>();

        if (_createClientFunc != null) return;
        _createClientFunc = name =>
        {
            return new Lazy<HttpClient>(() => new HttpClient(), LazyThreadSafetyMode.ExecutionAndPublication);
        };
    }
    #endregion

    #region Implementation
    public HttpClient CreateClient(string name)
    {
        if (name == null)
        {
            throw new ArgumentNullException(nameof(name));
        }

        return _httpClients.GetOrAdd(name, _createClientFunc).Value;
    }

    public void Dispose()
    {
        if (disposed) return;
        disposed = true;

        foreach (var name in _httpClients.Keys)
        {
            _httpClients[name].Value.Dispose();
        }
    }
    #endregion
}

แต่การใช้งาน IHttpClientFactory ของไมโครซอฟท์ยังสามารถนำมาใช้เพื่อสิ่งใหม่ล่าสุดและยิ่งใหญ่ที่สุด:

    var serviceCollection = new ServiceCollection();
    var baseUri = new Uri("http://www.test.com");
    serviceCollection.AddSingleton(typeof(ISerializationAdapter), typeof(NewtonsoftSerializationAdapter));
    serviceCollection.AddSingleton(typeof(ILogger), typeof(ConsoleLogger));
    serviceCollection.AddSingleton(typeof(IClient), typeof(Client));
    serviceCollection.AddDependencyInjectionMapping();
    serviceCollection.AddTransient<TestHandler>();

    //Make sure the HttpClient is named the same as the Rest Client
    serviceCollection.AddSingleton<IClient>(x => new Client(name: clientName, httpClientFactory: x.GetRequiredService<IHttpClientFactory>()));
    serviceCollection.AddHttpClient(clientName, (c) => { c.BaseAddress = baseUri; })
        .AddHttpMessageHandler<TestHandler>();

    var serviceProvider = serviceCollection.BuildServiceProvider();
    var client = serviceProvider.GetService<IClient>();
    await client.GetAsync<object>();

RestClient.Net ใช้เวลาในการฉีดบัญชีอ้างอิงการเยาะเย้ยภาชนะ IoC การทดสอบหน่วยและเหนือสิ่งอื่นใดนั้นรวดเร็ว ฉันได้ตามล่าไปแล้วและมีเพียงลูกค้ารายอื่นที่ดูเหมือนจะทำงานในความสามารถที่คล้ายกันคือ Flurl.Http


-2

ขั้นตอนแรกคือการสร้างคลาสผู้ช่วยสำหรับไคลเอนต์ http

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

namespace callApi.Helpers
{
    public class CallApi
    {
        private readonly Uri BaseUrlUri;
        private HttpClient client = new HttpClient();

        public CallApi(string baseUrl)
        {
            BaseUrlUri = new Uri(baseUrl);
            client.BaseAddress = BaseUrlUri;
            client.DefaultRequestHeaders.Accept.Clear();
            client.DefaultRequestHeaders.Accept.Add(
                new MediaTypeWithQualityHeaderValue("application/json"));

        }

        public HttpClient getClient()
        {
            return client;
        }

        public HttpClient getClientWithBearer(string token)
        {
            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
            return client;
        }

    }
}

จากนั้นคุณสามารถใช้คลาสนี้ในรหัสของคุณ

นี่เป็นตัวอย่างของวิธีการที่คุณเรียก API ที่เหลือโดยไม่ต้องมีผู้ถือโดยใช้คลาสข้างต้น

// GET api/values
[HttpGet]
public async Task<ActionResult<string>> postNoBearerAsync(string email, string password,string baseUrl, string action)
{
    var request = new LoginRequest
    {
        email = email,
        password = password
    };

    var callApi = new CallApi(baseUrl);
    var client = callApi.getClient();
    HttpResponseMessage response = await client.PostAsJsonAsync(action, request);
    if (response.IsSuccessStatusCode)
        return Ok(await response.Content.ReadAsAsync<string>());
    else
        return NotFound();
}

นี่เป็นตัวอย่างของวิธีที่คุณสามารถเรียก API ที่เหลือที่ต้องมีผู้ถือ

// GET api/values
[HttpGet]
public async Task<ActionResult<string>> getUseBearerAsync(string token, string baseUrl, string action)
{
    var callApi = new CallApi(baseUrl);
    var client = callApi.getClient();
    client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
    HttpResponseMessage response = await client.GetAsync(action);
    if (response.IsSuccessStatusCode)
    {
        return Ok(await response.Content.ReadAsStringAsync());

    }
    else
        return NotFound();
}

คุณยังสามารถดู repo ด้านล่างหากคุณต้องการดูตัวอย่างการทำงานของวิธีการทำงาน

https://github.com/mokh223/callApi

โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.