RestWrapper 3.1.2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. .NET Framework 4.6.2 This package targets .NET Framework 4.6.2. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package RestWrapper --version 3.1.2                

                    
                

            
NuGet\Install-Package RestWrapper -Version 3.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="RestWrapper" Version="3.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add RestWrapper --version 3.1.2                

                    
                

            
#r "nuget: RestWrapper, 3.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install RestWrapper as a Cake Addin
#addin nuget:?package=RestWrapper&version=3.1.2

// Install RestWrapper as a Cake Tool
#tool nuget:?package=RestWrapper&version=3.1.2

alt tag

RestWrapper

NuGet Version NuGet

A simple C# class library to help simplify sending REST API requests and retrieving responses (RESTful HTTP and HTTPS)

Special Thanks

Thanks go out to the community for their help in making this library great!

@nhaberl @jmkinzer @msasanmh @lanwah @nhaberl

New in v3.1.x

  • Minor breaking changes
  • Better internal support for chunked-transfer encoding
  • Remove non-async methods

Test Apps

Test projects are included which will help you exercise the class library.

Examples

// simple GET example
using RestWrapper;
using System.IO;

using (RestRequest req = new RestRequest("http://www.google.com/"))
{
	using (RestResponse resp = await req.SendAsync())
	{
		Console.WriteLine("Status: " + resp.StatusCode);
		// response data is in resp.Data
	}
}

// simple POST example
using RestWrapper;
using System.IO;

using (RestRequest req = new RestRequest("http://127.0.0.1:8000/api", HttpMethod.POST))
{
	using (RestResponse resp = await req.SendAsync("Hello, world!"))
	{
		Console.WriteLine("Status : " + resp.StatusCode);
		// response data is in resp.Data
	}
}

// sending form data
using RestWrapper;

using (RestRequest req = new RestRequest("http://127.0.0.1:8000/api", HttpMethod.POST))
{
	Dictionary<string, string> form = new Dictionary<string, string>();
	form.Add("foo", "bar");
	form.Add("hello", "world how are you");

	using (RestResponse resp = await req.SendAsync(form))
	{
		Console.WriteLine("Status : " + resp.StatusCode);
	}
}

// deserializing JSON
using RestWrapper;

using (RestRequest req = new RestRequest("http://127.0.0.1:8000/api"))
{
	using (RestResponse resp = await req.SendAsync())
	{
		MyObject obj = resp.DataFromJson<MyObject>();
	}
}

A Note on Performance and 'localhost'

RestWrapper uses the underlying HttpWebRequest and HttpWebResponse classes from System.Net. When using localhost as the target URL, you may notice in Wireshark that HttpWebRequest will first attempt to connect to the IPv6 loopback address, and not all services listen on IPv6. This can create a material delay of more than 1 second. In these cases, it is recommended that you use 127.0.0.1 instead of localhost for these cases.

Basic Telemetry

The RestResponse object contains a property called Time that can be useful for understanding how long a request took to complete.

RestRequest req = new RestRequest("https://www.cnn.com");
RestResponse resp = req.Send();
Console.WriteLine("Start    : " + resp.Time.Start);
Console.WriteLine("End      : " + resp.Time.End);
Console.WriteLine("Total ms : " + resp.Time.TotalMs + "ms");

Deserializing Response Data

The method RestResponse.DataFromJson<T>() will deserialize using System.Text.Json. You can override the RestResponse.SerializationHelper property with your own implementation of ISerializationHelper if you wish to use your own deserializer. Thank you @nhaberl for the suggestion.

Version History

Please refer to CHANGELOG.md for version history.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
.NET Framework net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (16)

Showing the top 5 NuGet packages that depend on RestWrapper:

Package Downloads
KvpbaseSDK

C# SDK for Kvpbase object storage platform
Komodo.Sdk

Client SDK in C# for Komodo. Please either install Komodo.Daemon to integrate search within your application, or Komodo.Server to run a standalone server if you wish to use this client SDK. Komodo is an information search, metadata, storage, and retrieval platform.
GoogleMapsClient

I needed a simple way to parse addresses and resolve coordinates to an address. Plug in a Google Maps API key and you're all set.
ArangoDBLite

ArangoDBLite is a lightweight SDK for the RESTful API provided by the ArangoDB graph database platform.
SendWithMailgun

Simple class library to send email and validate email addresses using Mailgun.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on RestWrapper:

Repository Stars
dotnet/WatsonWebserver
Watson is the fastest, easiest way to build scalable RESTful web servers and services in C#.
Version Downloads Last updated
3.1.3 125 12/13/2024
3.1.2 165 12/10/2024
3.1.1 87 12/10/2024
3.1.0 168 12/2/2024
3.0.22 289 10/29/2024
3.0.21 791 8/27/2024
3.0.20 2,314 5/21/2024
3.0.19 3,240 3/27/2024
3.0.18 1,058 1/16/2024
3.0.17 2,057 11/25/2023
3.0.16 464 11/10/2023
3.0.15 435 11/10/2023
3.0.14 1,054 10/21/2023
3.0.12 500 10/20/2023
3.0.11 484 10/20/2023
3.0.10 827 10/6/2023
3.0.9 430 10/6/2023
3.0.8 1,460 9/4/2023
3.0.7 520 9/4/2023
3.0.6 583 9/1/2023
3.0.5 574 8/31/2023
3.0.4 544 8/31/2023
3.0.3 1,310 8/24/2023
3.0.2 13,326 7/23/2023
3.0.1 1,284 7/12/2023
3.0.0 701 7/12/2023
2.3.2 3,590 3/27/2023
2.3.1.1 26,129 9/4/2022
2.3.1 2,641 8/15/2022
2.3.0 933 8/15/2022
2.2.1.15 1,678 8/11/2022
2.2.1.14 12,762 11/19/2021
2.2.1.13 28,199 11/12/2021
2.2.1.12 5,160 8/14/2021
2.2.1.11 6,348 5/10/2021
2.2.1.10 4,422 2/15/2021
2.2.1.9 906 2/15/2021
2.2.1.8 1,272 2/11/2021
2.2.1.7 979 2/11/2021
2.2.1.6 2,211 1/21/2021
2.2.1.5 2,594 12/28/2020
2.2.1.4 10,937 11/16/2020
2.2.1.3 4,216 11/15/2020
2.2.1.2 1,349 10/24/2020
2.2.1.1 1,029 10/24/2020
2.2.1 1,140 10/23/2020
2.2.0 1,114 10/23/2020
2.1.5 1,358 10/15/2020
2.1.4.2 13,748 9/10/2020
2.1.4.1 123,583 1/17/2020
2.1.4 14,010 12/5/2019
2.1.3 11,773 10/28/2019
2.1.2 4,247 9/22/2019
2.0.4 4,740 6/13/2019
2.0.3 1,809 6/5/2019
2.0.2 1,339 4/30/2019
1.0.9 6,959 3/10/2019
1.0.8 4,357 8/11/2017
1.0.7 1,615 6/23/2017
1.0.6 1,667 5/14/2017
1.0.5 1,685 10/11/2016
1.0.4 1,596 10/7/2016

Better support for chunked transfer-encoding.