C#を使用してREST APIを呼び出すにはどうすればよいですか?


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)メッセージが表示されるためです。しかし、catchブロックに配置したConsole.Out行が表示されません。

私のコンソール:

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との関係 = \ request.GetResponse行で爆破しています。
NullVoxPopuli

@TheLindyHop; 何もない。読み違えました。
NotMe 2012年

回答:


427

ASP.Net Web APIは、前述のWCF Web APIに代わるものです。

これらの応答のほとんどは2012年の初めからのものであり、このスレッドは「call restful service c#」をGoogle検索する際の上位の結果の1つであるため、更新した回答を投稿すると思いました。

マイクロソフトの現在のガイダンスは、Microsoft ASP.NET Web APIクライアントライブラリを使用してRESTfulサービスを利用することです。これは、Microsoft.AspNet.WebApi.ClientというNuGetパッケージとして入手できます。この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インスタンスでusingステートメントが使用されなかった理由の詳細については、この質問とその回答を参照してください。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/sumption-your-own-asp-net-web-api-rest-service/


6
ありがとう!これを機能させるには、WebApiクライアントのNuGetパッケージをインストールする必要がありました。Install-PackageMicrosoft.AspNet.WebApi.Client
Ev。

3
RESTライブラリの統合をモックアウトする必要がある場合、クライアントライブラリを使用しても、まだ簡単ではありません。RestSharpをお試しください。
ロブ教会

6
この回答を現在よりもさらに良くするには、HttpClient宣言をusingステートメントにラップして、リソースをより適切に管理する必要があります:)
Daniel Siebert

7
使用しようとしたが、 『ReadAsAsync』の定義なし拡張メソッドが含まれていませんReadAsAsync()、エラーを取得」HttpContentを使用することができません。
ロバート・グリーン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 2015

2
WebApiクライアントライブラリよりもはるかに簡単に、テスト用にモックアウトできるRestSharpへのもう1つの投票。
Rob Church

1
モノユーザーの場合-RestSharpはSystem.Net WebRequest APIを使用しているようです-私の経験では、これは.net実装ほど信頼性が高くありません。(「ランダム」がハングする)
トム

3
この回答の例を教えていただければ幸いです。
Caltor 2017年

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 2018年

@Jesse C. Slicer..WebResponseでエラー404が発生する理由webResponse = request.GetResponse();
Goh Han

2
リソースが見つからなかったからですか?404を取得するには多くの、多くの理由があります
ジェシーC.スライサー

1
これは@ JesseC.Slicerの優れたソリューションです。このコードを適用してトークンをプルし、コンソールから見ることができます。このトークンを取得して認証/ログインに使用するためのヒントはありますか?GETを使用して一部のデータをプルしたいのですが、ログインしている場合にのみ可能です。これについて詳しく知りたいのですが?ありがとう!
ポールラグナ

18

C#で外部APIを呼び出すいくつかの異なる方法を次に示します(2019年更新)。

.NETの組み込みの方法:

  • WebRequestWebClient-詳細なAPIとMicrosoftのドキュメントは簡単には理解できません
  • HttpClient-ブロック上の.NETの最新の子供であり、上記よりもはるかに簡単に使用できます。

率直に言って、.NETの組み込みクライアントよりもはるかに優れた開発者エクスペリエンスを備えた無料のオープンソースNuGetパッケージ

  • ServiceStack.Text(1k githubスター、7m Nugetダウンロード)(*)-高速、軽量、弾力性。
  • RestSharp(6k githubスター、23m Nugetダウンロード)(*)-シンプルなRESTおよびHTTP APIクライアント
  • Flurl(1.7k github stars、3m Nuget Downloads)(*)-流暢で移植可能なテスト可能なHTTPクライアントライブラリ

上記のすべてのパッケージは、優れた開発者エクスペリエンス(つまり、簡潔で簡単なAPI)を提供し、十分に維持されます。

(*) 2019年8月現在

例:ServiceStack.Textを使用して、Fake Rest APIからTodoアイテムを取得します。 他のライブラリの構文は非常に似ています。

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

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/");

1つだけ取得する例:

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

2
これは本当にいいコードですが、usingブロック内ではhttpclientを使用しないでください。aspnetmonsters.com/2016/08/2016-08-27-httpclientwrong
Myke Black

9

.NET 4.5または.NET Coreを使用するときにREST APIを呼び出すための更新

DalSoft.RestClientをお勧めします(作成した警告)。その理由は、動的型付けを使用しているため、シリアライゼーション/デシリアライゼーションを含む1つの流暢な呼び出しですべてをラップできるからです。以下は、実際のP​​UTの例です。

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;
    }
}

注:JSONをシリアル化してデジシリアライズするために、Newtonsoft.Json NuGetパッケージを使用しました。


4

.netから残りのサービスを呼び出すためのRefitを確認してください。私はそれが非常に使いやすいとわかりました:https : //github.com/paulcbetts/refit

再フィット:.NET Core、Xamarin、.NET用の自動タイプセーフRESTライブラリ

Refitは、SquareのRetrofitライブラリに強く影響を受けたライブラリであり、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");

Refitがこれを達成するために反射を使用するかどうかを知っていますか?どこにも情報が見つかりません。
tfrascaroli

申し訳ありませんが@tfrascaroli手元にあるかわかりません。
patrickbadley

2

これは確かに機能するサンプルコードです。Restサービスから一連のオブジェクトを読み取るためにこれを作成するのに1日かかりました。

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

この簡単な方法で、Web Api 2.0でそれを行いました。UseDefaultCredentialsを削除できます。私は自分のユースケースで使用しました。

            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

Visual Studio 11 Betaを使用しているため、最新かつ最高のものを使用する必要があります。新しいWeb APIには、このためのクラスが含まれています。

HttpClientを参照してください:http ://wcf.codeplex.com/wikipage ? title = WCF%20HTTP


0

ここでマークされた答えは、HttpClientを直接使用して処分することを示唆しています。これでうまくいくかもしれませんが、正しく使用しないとHttpClientで問題が発生するのは簡単です。HttpClientを使用する場合は、HttpClientの作成/破棄を、ファクトリパターンを使用するサードパーティライブラリに引き渡す方がよいでしょう。RestClient.Netはそのようなライブラリの1つです。

非常に基本的な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
}

ただし、Microsoftの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;
        }

    }
}

次に、このクラスをコードで使用できます。

これは、上記のクラスを使用して無記名なしでREST 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();
}

動作例を確認したい場合は、以下のリポジトリを参照することもできます。

https://github.com/mokh223/callApi

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.