RestSharp​.net REST/HTTP 工具库

Posted 2021-04-01 UP技术控

说明

RestSharp的主要目的是通过HTTP对远程资源进行同步和异步调用。顾名思义，RestSharp的主要受众是使用REST API的开发人员。但是，只要您拥有要发送的资源URI和请求参数符合W3C HTTP标准，RestSharp可以通过HTTP调用任何API（但不能调用HTTP / 2）。

为.NET开发人员使用HTTP API的主要挑战之一是处理不同种类的请求和响应，并将它们转换为复杂的C＃类型。RestSharp可以负责将请求正文序列化为JSON或XML并反序列化响应。它还可以根据不同的参数类型（路径，查询，表单或正文）形成有效的请求URI。

入门

您必须先添加NuGet软件包，然后才能在应用程序中使用RestSharp。您可以使用IDE或命令行执行此操作：

dotnet add package RestSharp

基本用法

如果您只对API提出了一些一次性请求，则可以这样使用RestSharp：

using RestSharp;using RestSharp.Authenticators;
var client = new RestClient("https://api.twitter.com/1.1");client.Authenticator = new HttpBasicAuthenticator("username", "password");
var request = new RestRequest("statuses/home_timeline.json", DataFormat.Json);
var response = client.Get(request);

IRestResponse包含从远程服务器返回的所有信息。您可以访问标题，内容，HTTP状态等。

我们建议使用通用重载，例如Get<T>将响应自动反序列化为.NET类。

异步呼叫

所有同步方法都有其异步同级，后缀为Async。

因此，您可以使用和来代替Get<T>返回T或Execute<T>返回。参数集通常是相同的。您可以选择提供取消令牌，该令牌默认设置为。IRestResponse<T>GetAsync<T>ExecuteAsync<T>CancellationToken.None

例如：

using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.twitter.com/1.1");
client.Authenticator = new HttpBasicAuthenticator("username", "password");

var request = new RestRequest("statuses/home_timeline.json", DataFormat.Json);

var timeline = await client.GetAsync<HomeTimeline>(request, cancellationToken);

不过，最重要的区别是，以HTTP方法命名的异步方法返回Task<T>而不是Task<IRestResponse<T>>。因为这意味着如果请求失败，您将不会收到错误响应，因此这些方法将引发异常。

ExecuteAsync但是，所有重载的行为都与相同，Execute并返回IRestResponse或IRestResponse<T>。

内容类型

RestSharp支持将XML或JSON正文作为请求的一部分发送。要将主体添加到请求中，只需调用实例的AddJsonBody或AddXmlBody方法IRestRequest。

使用这些方法时，无需设置Content-Type或DataFormat在请求中添加参数，RestSharp会为您完成此操作。

RestSharp还将处理XML和JSON响应，并根据服务器响应类型执行所有必要的反序列化任务。因此，仅在Accept要手动反序列化响应时才需要添加标头。

例如，只需要这些行即可使用JSON正文进行请求：

var request = new RestRequest("address/update") .AddJsonBody(updatedAddress);var response = await client.PostAsync<AddressUpdateResponse>(request);

响应

当使用Execute或时ExecuteAsync，您将获得IRestResponse具有Content属性的back实例，该实例以字符串形式包含响应。您可以在那里找到其他有用的属性，例如StatusCode，ContentType等等。如果请求未成功，您将获得响应，并将IsSuccessful属性设置为，false并且在ErrorException和ErrorMessage属性中说明了错误。

使用typeExecute<T>或时ExecuteAsync<T>，您将获得IRestResponse<T>back的实例，该实例与back实例相同，IRestResponse但也包含T Data具有反序列化响应的属性。

扩展喜欢Get<T>并且GetAsync<T>不会返回全部，IRestResponse<T>而只是反序列化的响应。null如果出现问题，您可能会回来，并且很难理解该问题。因此，在使用类型化扩展方法时，建议将IRestClient.ThrowOnAnyError属性设置为true。这样，您告诉RestSharp在出现问题时引发异常。然后，您可以将调用包装在try/catch块中，并相应地处理异常。