RestEase 1.6.4

.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Standard 1.1 This package targets .NET Standard 1.1. The package is compatible with this framework or higher. .NET Framework 4.5.2 This package targets .NET Framework 4.5.2. The package is compatible with this framework or higher. 
dotnet add package RestEase --version 1.6.4
                    


                    

                
NuGet\Install-Package RestEase -Version 1.6.4
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="RestEase" Version="1.6.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="RestEase" Version="1.6.4" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="RestEase" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add RestEase --version 1.6.4
                    


                    

                
#r "nuget: RestEase, 1.6.4"
#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. 
#:package RestEase@1.6.4
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=RestEase&version=1.6.4
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=RestEase&version=1.6.4
                    


                            Install as a Cake Tool

Project Icon RestEase

NuGet Build status

RestEase is a little type-safe REST API client library for .NET Framework 4.5.2 and higher and .NET Platform Standard 1.1 and higher, which aims to make interacting with remote REST endpoints easy, without adding unnecessary complexity.

To use it, you define an interface which represents the endpoint you wish to communicate with (more on that in a bit), where methods on that interface correspond to requests that can be made on it. RestEase will then generate an implementation of that interface for you, and by calling the methods you defined, the appropriate requests will be made. See Installation and Quick Start to get up and running!

Almost every aspect of RestEase can be overridden and customized, leading to a large level of flexibility.

It also works on platforms which don't support runtime code generation, such as .NET Native and iOS, if you reference RestEase.SourceGenerator. See Using RestEase.SourceGenerator for more information.

RestEase is built on top of HttpClient and is deliberately a "leaky abstraction": it is easy to gain access to the full capabilities of HttpClient, giving you control and flexibility, when you need it.

RestEase is inspired by Anaïs Betts' Refit, which in turn is inspired by Retrofit.

Table of Contents

  1. Installation
  2. Quick Start
  3. Request Types
  4. Return Types
  5. Query Parameters
    1. Constant Query Parameters
    2. Variable Query Parameters
      1. Formatting Variable Query Parameters
      2. Serialization of Variable Query Parameters
    3. Query Parameters Map
    4. Raw Query String Parameters
    5. Query Properties
  6. Paths
    1. Base Address
    2. Base Path
    3. Path Placeholders
      1. Path Parameters