https://github.com/jchristn/restwrapper

RestWrapper is a simple C# class library to help simplify sending REST API requests and retrieving responses (RESTful HTTP and HTTPS)
https://github.com/jchristn/restwrapper

api http http-client http-server https nuget rest rest-api restclient restwrapper

Last synced: 5 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jchristn/restwrapper
• Owner: jchristn
• License: mit
• Created: 2016-07-20T22:14:48.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T06:46:12.000Z (3 months ago)
• Last Synced: 2024-10-29T07:09:18.750Z (3 months ago)
• Topics: api, http, http-client, http-server, https, nuget, rest, rest-api, restclient, restwrapper
• Language: C#
• Homepage:
• Size: 17.3 MB
• Stars: 26
• Watchers: 5
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
![alt tag](https://raw.githubusercontent.com/jchristn/RestWrapper/master/assets/icon.ico)

# RestWrapper

[![NuGet Version](https://img.shields.io/nuget/v/RestWrapper.svg?style=flat)](https://www.nuget.org/packages/RestWrapper/) [![NuGet](https://img.shields.io/nuget/dt/RestWrapper.svg)](https://www.nuget.org/packages/RestWrapper) 

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

```csharp

// 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

	}

}

```

```csharp

// 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

	}

}

```

```csharp

// sending form data

using RestWrapper;

using (RestRequest req = new RestRequest("http://127.0.0.1:8000/api", HttpMethod.POST))

{

	Dictionary form = new Dictionary();

	form.Add("foo", "bar");

	form.Add("hello", "world how are you");

	using (RestResponse resp = await req.SendAsync(form))

	{

		Console.WriteLine("Status : " + resp.StatusCode);

	}

}

```

```csharp

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

	}

}

```

## 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.

```csharp

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()` 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.