TypedRest.CommandLine
1.5.4
dotnet add package TypedRest.CommandLine --version 1.5.4
NuGet\Install-Package TypedRest.CommandLine -Version 1.5.4
<PackageReference Include="TypedRest.CommandLine" Version="1.5.4" />
paket add TypedRest.CommandLine --version 1.5.4
#r "nuget: TypedRest.CommandLine, 1.5.4"
// Install TypedRest.CommandLine as a Cake Addin #addin nuget:?package=TypedRest.CommandLine&version=1.5.4 // Install TypedRest.CommandLine as a Cake Tool #tool nuget:?package=TypedRest.CommandLine&version=1.5.4
for .NET
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
Adds support for streaming with ReactiveX (Rx).
Create endpoints using the types in the TypedRest.Endpoints.Reactive
namespace.
Adds support for serializing using System.Text.Json instead of Newtonsoft.Json.
Pass new SystemTextJsonSerializer()
to the EntryEndpoint
constructor.
Adds support for OAuth 2.0 / OpenID Connect authentication to HttpClient.
Call .AddOAuthHandler()
after .AddTypedRest()
(or .AddHttpClient()
when not using main TypedRest package).
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 | Versions 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 is compatible. net8.0-android was computed. net8.0-browser 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. |
-
.NETStandard 2.0
- TypedRest.Reactive (>= 1.5.4)
-
.NETStandard 2.1
- TypedRest.Reactive (>= 1.5.4)
-
net6.0
- TypedRest.Reactive (>= 1.5.4)
-
net8.0
- TypedRest.Reactive (>= 1.5.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
1.5.4 | 91 | 9/8/2024 |
1.5.3 | 107 | 7/7/2024 |
1.5.2 | 156 | 12/27/2023 |
1.5.1 | 166 | 10/4/2023 |
1.5.0 | 140 | 10/3/2023 |
1.4.1 | 159 | 10/1/2023 |
1.4.0 | 197 | 9/30/2023 |
1.3.8 | 300 | 3/12/2023 |
1.3.7 | 389 | 11/28/2022 |
1.3.6 | 1,204 | 11/29/2021 |
1.3.5 | 389 | 9/5/2021 |
1.3.4 | 480 | 1/29/2021 |
1.3.3 | 523 | 11/30/2020 |
1.3.2 | 502 | 11/27/2020 |
1.3.1 | 578 | 11/20/2020 |
1.3.0 | 592 | 9/20/2020 |
1.2.1 | 526 | 9/14/2020 |
1.2.0 | 533 | 8/26/2020 |
1.1.0 | 581 | 5/28/2020 |
1.1.0-rc0001 | 408 | 5/12/2020 |
1.0.3 | 658 | 3/23/2020 |
1.0.2 | 611 | 3/6/2020 |
1.0.1 | 615 | 3/6/2020 |
1.0.0 | 643 | 12/11/2019 |
1.0.0-rc0001 | 423 | 9/26/2019 |
0.43.0 | 1,001 | 1/8/2019 |
0.42.0 | 815 | 12/11/2018 |
0.41.0 | 828 | 10/23/2018 |
0.40.0 | 934 | 10/10/2018 |
0.39.0 | 904 | 9/13/2018 |
0.38.2 | 1,038 | 8/21/2018 |
0.38.1 | 1,165 | 3/28/2018 |
0.38.0 | 1,200 | 3/28/2018 |
0.37.0 | 1,156 | 3/13/2018 |
0.36.0 | 1,108 | 9/14/2017 |
0.35.0 | 1,204 | 5/12/2017 |
0.34.0 | 1,116 | 12/13/2016 |
0.33.0 | 1,164 | 11/23/2016 |
0.32.0 | 1,040 | 11/9/2016 |
0.31.0 | 1,090 | 10/18/2016 |
0.30.0 | 1,082 | 10/11/2016 |
0.29.1 | 1,068 | 9/5/2016 |
0.29.0 | 1,072 | 9/5/2016 |
0.28.0 | 1,256 | 7/11/2016 |
0.27.0 | 1,082 | 6/21/2016 |
0.26.0 | 1,475 | 6/15/2016 |
0.25.0 | 1,120 | 6/2/2016 |
0.24.0 | 1,144 | 5/30/2016 |
0.23.0 | 1,107 | 5/25/2016 |
0.22.0 | 1,085 | 5/9/2016 |
0.21.0 | 1,125 | 5/3/2016 |
0.20.0 | 1,058 | 5/2/2016 |
0.19.0 | 1,085 | 4/29/2016 |
0.18.0 | 1,384 | 4/27/2016 |
0.17.0 | 1,080 | 4/14/2016 |
0.16.0 | 1,115 | 4/7/2016 |
0.15.0 | 1,081 | 3/18/2016 |
0.14.0 | 1,591 | 2/27/2016 |
0.13.0 | 1,126 | 2/4/2016 |
0.12.0 | 1,123 | 1/25/2016 |
0.11.0 | 1,170 | 1/18/2016 |
0.10.0 | 1,152 | 1/7/2016 |
0.9.0 | 1,103 | 12/17/2015 |
0.8.0 | 1,145 | 12/10/2015 |
0.7.0 | 1,169 | 10/29/2015 |
0.6.0 | 1,122 | 10/23/2015 |
0.5.0 | 1,101 | 10/21/2015 |
0.4.0 | 1,129 | 10/16/2015 |
0.3.0 | 1,139 | 10/15/2015 |
0.2.0 | 1,185 | 10/12/2015 |
0.1.0 | 1,424 | 9/25/2015 |