Remora.Rest 2.0.2

Prefix Reserved
.NET 5.0 This package targets .NET 5.0. The package is compatible with this framework or higher. .NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Remora.Rest --version 2.0.2                

                    
                

            
NuGet\Install-Package Remora.Rest -Version 2.0.2
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="Remora.Rest" Version="2.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Remora.Rest --version 2.0.2                

                    
                

            
#r "nuget: Remora.Rest, 2.0.2"
#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 Remora.Rest as a Cake Addin
#addin nuget:?package=Remora.Rest&version=2.0.2

// Install Remora.Rest as a Cake Tool
#tool nuget:?package=Remora.Rest&version=2.0.2

Remora.Rest

Remora.Rest is a compact helper library for building REST API wrappers, giving you the tools you need to rapidly create robust, highly configurable wrappers of your own.

The library is somewhat opinionated, and it does target a single subset of REST API types - those whose payloads (error or otherwise) are JSON-serialized. For these use cases, however, the library is quite adept at what it does.

Quickstart

At its core, the library expects you to do two things - one, to access the REST endpoints through a configured RestHttpClient<TError>, and two, to define the entities in the API model through an interface/implementation combination.

var services = new ServiceCollection();

var clientBuilder = services
    .AddRestHttpClient<RestHttpClient<ErrorPayloadType>>();

// Perform HttpClient configuration (adding Polly policies, setting default
// request headers, etc)
clientBuilder...

// Configure API model types
services.Configure<JsonSerializerOptions>(clientBuilder.Name, options => 
{
    options.AddDataObjectConverter<IModelType, ModelType>();
});

After you've set up your client and your types, you can then inject an instance of RestHttpClient<TError> into your actual API wrapper type (the instance is transient, so you can treat it the same as any HttpClient you'd normally inject).

public class MyWrapper
{
    private readonly RestHttpClient<ErrorPayloadType> _restClient;
    
    public MyWrapper(RestHttpClient<ErrorPayloadType> restClient)
    {
        _restClient = restClient;
    }
}

More detailed documentation will hopefully be available in the future; in the meantime, check out Remora.Discord, for which this project was originally developed - it pushes all available functionality to its limits, and serves as a relatively comprehensive demonstration of what you can do with the library.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  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-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 netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on Remora.Rest:

Package Downloads
Remora.Discord.API

Remora.Discord's implementation of Discord's API objects
MyAnimeList.Net.Rest

Package Description
MyAnimeList.Net.API.Abstractions

Package Description
Remora.OAuth2

Remora.OAuth2's implementation of OAuth2's API objects
XkcdSharp

A C# wrapper for easy interacting with https://xkcd.com/

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Remora.Rest:

Repository Stars
Remora/Remora.Discord
A data-oriented C# Discord library, focused on high-performance concurrency and robust design.
Version Downloads Last updated
3.4.0 40,038 3/31/2024
3.3.2 26,261 11/20/2023
3.3.1 47,601 11/14/2023
3.3.0 326 9/10/2023
3.2.1 32,736 7/14/2023
3.2.0 281 5/22/2023
3.1.3 22,184 2/26/2023
3.1.2 9,532 12/28/2022
3.1.1 6,505 11/20/2022
3.1.0 5,079 10/14/2022
3.0.1 21,656 8/26/2022
3.0.0 418 8/25/2022
2.0.6 5,203 8/19/2022
2.0.5 448 8/3/2022
2.0.4 36,294 6/19/2022
2.0.3 4,868 6/18/2022
2.0.2 9,018 6/8/2022
2.0.1 15,799 5/14/2022
2.0.0 424 5/14/2022
1.2.4 11,329 5/3/2022
1.2.3 8,507 4/19/2022
1.2.2 23,645 3/5/2022
1.2.1 436 2/20/2022
1.2.0 9,301 2/19/2022
1.1.3 5,922 2/13/2022
1.1.2 56,761 11/27/2021
1.1.1 3,761 11/26/2021
1.1.0 4,427 11/20/2021
1.0.0 336 11/14/2021

Improve Result usage.
           Upgrade Remora.Results.