Simple REST and HTTP API Client for .NET
Clone or download
Pull request Compare This branch is 2 commits ahead, 323 commits behind restsharp:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.nuget prepped a new version and fixed the build bat for monotouch and remov… Aug 26, 2015
.vscode Convert tests to Xunit and Port to netcoreapp so it will run properly May 30, 2017
RestSharp.IntegrationTests Convert tests to Xunit and Port to netcoreapp so it will run properly May 30, 2017
RestSharp.Tests Convert tests to Xunit and Port to netcoreapp so it will run properly May 30, 2017
RestSharp Convert tests to Xunit and Port to netcoreapp so it will run properly May 30, 2017
Tools added this prefix to the compression library (missed before) and clea… Aug 16, 2015
.gitattributes Add gitattributes and fix line-endings Sep 7, 2013
.gitignore Add integration test for OAuth1 authentication against Twitter API Dec 8, 2014
CONTRIBUTING.markdown Converted tabs to spaces and corrected an error; Oct 26, 2014
LICENSE.txt Added license Nov 16, 2009
README.markdown It supports PATCH Apr 20, 2016
RestSharp.sln Convert tests to Xunit and Port to netcoreapp so it will run properly May 30, 2017
RestSharp.snk Added capability for strong naming on the core library. This was done… Nov 7, 2014
appveyor.yml updated appveyor.yml Aug 19, 2015
build.bat prepped a new version and fixed the build bat for monotouch and remov… Aug 26, 2015
readme.txt Added nuget targets for windows phone 8 and 8.1, monotouch10, monoand… Aug 19, 2015
releasenotes.markdown updated release notes Aug 19, 2015
restsharp.nuspec adding NuSpecUpdateTask to RestSharp.csproj Aug 27, 2013

README.markdown

RestSharp - Simple .NET REST Client Build status

RestSharp is in need of more maintainers. Specifically ones who have more experience with PCL and UWP. If you're interested, please open an issue at RestSharp Maintainers.

Official Site/Blog - @RestSharp

License: Apache License 2.0

Features

  • Supports .NET 3.5+, Silverlight 5, Windows Phone 8, Mono, MonoTouch, Mono for Android
  • Easy installation using NuGet for most .NET flavors
  • Supports strong naming using NuGet for most .NET flavors
  • Automatic XML and JSON deserialization
  • Supports custom serialization and deserialization via ISerializer and IDeserializer
  • Fuzzy element name matching ('product_id' in XML/JSON will match C# property named 'ProductId')
  • Automatic detection of type of content returned
  • GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE supported
  • Other non-standard HTTP methods also supported
  • oAuth 1, oAuth 2, Basic, NTLM and Parameter-based Authenticators included
  • Supports custom authentication schemes via IAuthenticator
  • Multi-part form/file uploads
  • T4 Helper to generate C# classes from an XML document
var client = new RestClient("http://example.com");
// client.Authenticator = new HttpBasicAuthenticator(username, password);

var request = new RestRequest("resource/{id}", Method.POST);
request.AddParameter("name", "value"); // adds to POST or URL querystring based on Method
request.AddUrlSegment("id", "123"); // replaces matching token in request.Resource

// add parameters for all properties on an object
request.AddObject(object);

// or just whitelisted properties
request.AddObject(object, "PersonId", "Name", ...);

// easily add HTTP Headers
request.AddHeader("header", "value");

// add files to upload (works with compatible verbs)
request.AddFile("file", path);

// execute the request
IRestResponse response = client.Execute(request);
var content = response.Content; // raw content as string

// or automatically deserialize result
// return content type is sniffed but can be explicitly set via RestClient.AddHandler();
IRestResponse<Person> response2 = client.Execute<Person>(request);
var name = response2.Data.Name;

// or download and save file to disk
client.DownloadData(request).SaveAs(path);

// easy async support
client.ExecuteAsync(request, response => {
    Console.WriteLine(response.Content);
});

// async with deserialization
var asyncHandle = client.ExecuteAsync<Person>(request, response => {
    Console.WriteLine(response.Data.Name);
});

// abort the request on demand
asyncHandle.Abort();