TypedRest 1.5.1

.NET 6.0 .NET Standard 2.0
dotnet add package TypedRest --version 1.5.1
NuGet\Install-Package TypedRest -Version 1.5.1
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.5.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TypedRest --version 1.5.1
#r "nuget: TypedRest, 1.5.1"
#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 TypedRest as a Cake Addin
#addin nuget:?package=TypedRest&version=1.5.1

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

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).
Create endpoints using the types in the TypedRest.Endpoints.Reactive namespace.

TypedRest.SystemTextJson
Adds support for serializing using System.Text.Json instead of Newtonsoft.Json.
Pass new SystemTextJsonSerializer() to the EntryEndpoint constructor.

TypedRest.OAuth
Adds support for OAuth 2.0 / OpenID Connect authentication to HttpClient.
Call .AddOAuthHandler() after .AddTypedRest() (or .AddHttpClient() when not using main TypedRest package).

TypedRest.CommandLine
Build command-line interfaces for TypedRest clients.
Create commands mirroring the endpoints using the types in the TypedRest.CommandLine.Commands namespace.

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 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 was computed.  net8.0-android 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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  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)
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. Create endpoints using the types in the TypedRest.Endpoints.Reactive namespace.

PowerDns.Client

Client library for the PowerDNS API

TypedRest.SystemTextJson

Adds support for serializing using System.Text.Json to TypedRest. Pass new SystemTextJsonSerializer() to the EntryEndpoint constructor.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.5.1 375 10/4/2023
1.5.0 140 10/3/2023
1.4.1 123 10/1/2023
1.4.0 137 9/30/2023
1.3.8 1,575 3/12/2023
1.3.7 1,322 11/28/2022
1.3.6 2,749 11/29/2021
1.3.5 875 9/5/2021
1.3.4 1,179 1/29/2021
1.3.3 4,441 11/30/2020
1.3.2 723 11/27/2020
1.3.1 812 11/20/2020
1.3.0 1,473 9/20/2020
1.2.1 816 9/14/2020
1.2.0 815 8/26/2020
1.1.0 1,291 5/28/2020
1.1.0-rc0001 444 5/12/2020
1.0.3 1,959 3/23/2020
1.0.2 1,254 3/6/2020
1.0.1 1,119 3/6/2020
1.0.0 7,593 12/11/2019
1.0.0-rc0001 556 9/26/2019
0.43.0 4,284 1/8/2019
0.42.0 1,020 12/11/2018
0.41.0 1,651 10/23/2018
0.40.0 1,479 10/10/2018
0.39.0 1,445 9/13/2018
0.38.2 1,229 8/21/2018
0.38.1 1,374 3/28/2018
0.38.0 1,369 3/28/2018
0.37.0 1,375 3/13/2018
0.36.0 1,317 9/14/2017
0.35.0 1,418 5/12/2017
0.34.0 1,421 12/13/2016
0.33.0 1,440 11/23/2016
0.32.0 1,395 11/9/2016
0.31.0 1,413 10/18/2016
0.30.0 1,400 10/11/2016
0.29.1 1,396 9/5/2016
0.29.0 1,417 9/5/2016
0.28.0 1,623 7/11/2016
0.27.0 1,404 6/21/2016
0.26.0 1,762 6/15/2016
0.25.0 1,397 6/2/2016
0.24.0 1,464 5/30/2016
0.23.0 1,389 5/25/2016
0.22.0 1,339 5/9/2016
0.21.0 1,405 5/3/2016
0.20.0 1,401 5/2/2016
0.19.0 1,408 4/29/2016
0.18.0 1,663 4/27/2016
0.17.0 1,431 4/14/2016
0.16.0 1,409 4/7/2016
0.15.0 1,367 3/18/2016
0.14.0 1,730 2/27/2016
0.13.0 1,418 2/4/2016
0.12.0 1,402 1/25/2016
0.11.0 1,498 1/18/2016
0.10.0 1,527 1/7/2016
0.9.0 1,411 12/17/2015
0.8.0 1,419 12/10/2015
0.7.0 1,467 10/29/2015
0.6.0 1,232 10/23/2015
0.5.0 1,247 10/21/2015
0.4.0 1,270 10/16/2015
0.3.0 1,268 10/15/2015
0.2.0 1,228 10/12/2015
0.1.0 1,734 9/25/2015