TypedRest 1.3.7

.NET 6.0 .NET Standard 2.0
dotnet add package TypedRest --version 1.3.7
NuGet\Install-Package TypedRest -Version 1.3.7
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="TypedRest" Version="1.3.7" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TypedRest --version 1.3.7
#r "nuget: TypedRest, 1.3.7"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install TypedRest as a Cake Addin
#addin nuget:?package=TypedRest&version=1.3.7

// Install TypedRest as a Cake Tool
#tool nuget:?package=TypedRest&version=1.3.7

TypedRest for .NET

Build API documentation
TypedRest helps you build type-safe, fluent-style REST API clients. Common REST patterns such as collections are represented as classes, allowing you to write more idiomatic code.

var client = new MyClient(new Uri("http://example.com/"));

// GET /contacts
List<Contact> contactList = await client.Contacts.ReadAllAsync();

// POST /contacts -> Location: /contacts/1337
ContactEndpoint smith = await client.Contacts.CreateAsync(new Contact {Name = "Smith"});
//ContactEndpoint smith = client.Contacts["1337"];

// GET /contacts/1337
Contact contact = await smith.ReadAsync();

// PUT /contacts/1337/note
await smith.Note.SetAsync(new Note {Content = "some note"});

// GET /contacts/1337/note
Note note = await smith.Note.ReadAsync();

// DELETE /contacts/1337
await smith.DeleteAsync();

Read a more detailed Introduction to TypedRest or jump right in with the Getting started guide.

You can also take a look at our Sample project.

NuGet packages

TypedRest
The main TypedRest library.

TypedRest.Reactive
Adds support for streaming with ReactiveX (Rx) to TypedRest.

TypedRest.OAuth
Provides an HttpClient DelegatingHandler for OAuth 2.0 / OpenID Connect authentication.
This can also be used independently of the other TypedRest packages.

TypedRest.CommandLine
Build command-line interfaces for TypedRest clients.

Building

The source code is in src/, config for building the API documentation is in doc/ and generated build artifacts are placed in artifacts/. The source code does not contain version numbers. Instead the version is determined during CI using GitVersion.

To build run .\build.ps1 or ./build.sh (.NET SDK is automatically downloaded if missing using 0install).

Contributing

We welcome contributions to this project such as bug reports, recommendations and pull requests.

This repository contains an EditorConfig file. Please make sure to use an editor that supports it to ensure consistent code style, file encoding, etc.. For full tooling support for all style and naming conventions consider using JetBrains' ReSharper or Rider products.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48 net481
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on TypedRest:

Package Downloads
TypedRest.Reactive

Adds support for streaming with ReactiveX (Rx) to TypedRest.

PowerDns.Client

Client library for the PowerDNS API

TypedRest.JsonPatch

Adds support for JSON Patch to TypedRest.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.7 402 11/28/2022
1.3.6 2,353 11/29/2021
1.3.5 699 9/5/2021
1.3.4 993 1/29/2021
1.3.3 3,473 11/30/2020
1.3.2 582 11/27/2020
1.3.1 644 11/20/2020
1.3.0 1,292 9/20/2020
1.2.1 651 9/14/2020
1.2.0 656 8/26/2020
1.1.0 1,084 5/28/2020
1.1.0-rc0001 388 5/12/2020
1.0.3 1,713 3/23/2020
1.0.2 1,030 3/6/2020
1.0.1 898 3/6/2020
1.0.0 5,879 12/11/2019
1.0.0-rc0001 502 9/26/2019
0.43.0 3,963 1/8/2019
0.42.0 850 12/11/2018
0.41.0 1,417 10/23/2018
0.40.0 1,305 10/10/2018
0.39.0 1,213 9/13/2018
0.38.2 1,068 8/21/2018
0.38.1 1,205 3/28/2018
0.38.0 1,203 3/28/2018
0.37.0 1,228 3/13/2018
0.36.0 1,175 9/14/2017
0.35.0 1,266 5/12/2017
0.34.0 1,198 12/13/2016
0.33.0 1,220 11/23/2016
0.32.0 1,188 11/9/2016
0.31.0 1,186 10/18/2016
0.30.0 1,167 10/11/2016
0.29.1 1,167 9/5/2016
0.29.0 1,208 9/5/2016
0.28.0 1,419 7/11/2016
0.27.0 1,187 6/21/2016
0.26.0 1,578 6/15/2016
0.25.0 1,193 6/2/2016
0.24.0 1,213 5/30/2016
0.23.0 1,154 5/25/2016
0.22.0 1,138 5/9/2016
0.21.0 1,195 5/3/2016
0.20.0 1,182 5/2/2016
0.19.0 1,186 4/29/2016
0.18.0 1,443 4/27/2016
0.17.0 1,216 4/14/2016
0.16.0 1,186 4/7/2016
0.15.0 1,145 3/18/2016
0.14.0 1,530 2/27/2016
0.13.0 1,216 2/4/2016
0.12.0 1,181 1/25/2016
0.11.0 1,283 1/18/2016
0.10.0 1,287 1/7/2016
0.9.0 1,184 12/17/2015
0.8.0 1,203 12/10/2015
0.7.0 1,256 10/29/2015
0.6.0 1,043 10/23/2015
0.5.0 1,061 10/21/2015
0.4.0 1,083 10/16/2015
0.3.0 1,069 10/15/2015
0.2.0 1,052 10/12/2015
0.1.0 1,548 9/25/2015