Oakrey.Network.Rest 2.0.4

Oakrey.Network.Rest

A .NET library that wraps HttpClient with a reactive observation layer. RestClient exposes GET, POST, PUT, and DELETE over a simple string-based API and publishes every outgoing request and incoming response as IObservable streams.

Main features

• Get, Post, Put, Delete synchronous convenience methods returning the response body as a string
• SendData(RestCommand) for command-object-driven dispatch
• IObservable<HttpResponseMessage> � subscribe to all responses
• IObservable<HttpRequestMessage> via Requests property � observe all outgoing requests
• Pluggable content settings via IRestSetting (JsonRestSettings, XmlRestSettings, TextRestSettings)
• Integrated structured logging via Oakrey.Log
• Implements IDisposable; disposes both ReplaySubject instances on teardown

Architecture

classDiagram
    class IRestClient {
        <<interface>>
        +Requests IObservable~HttpRequestMessage~
        +Get(url) string
        +Post(url, body) string
        +Put(url, body) string
        +Delete(url) string
        +SendData(RestCommand) string
    }
    class RestClient {
        +RestClient()
        +RestClient(IRestSetting setting)
        +Subscribe(IObserver~HttpResponseMessage~) IDisposable
        +Dispose()
    }
    class IRestSetting {
        <<interface>>
        +Encoding Encoding
        +MediaType string
    }
    class JsonRestSettings
    class XmlRestSettings
    class TextRestSettings
    class RestCommand {
        +Url string
        +Body string
        +Method MethodType
        +Get(url)$ RestCommand
        +Post(url, body)$ RestCommand
        +Put(url, body)$ RestCommand
        +Delete(url)$ RestCommand
    }
    class MethodType {
        <<enumeration>>
        Get
        Post
        Put
        Delete
        Options
        Head
        Trace
        Patch
        Connect
    }
    RestClient ..|> IRestClient
    RestClient --> IRestSetting
    IRestSetting <|.. JsonRestSettings
    IRestSetting <|.. XmlRestSettings
    IRestSetting <|.. TextRestSettings
    RestClient --> RestCommand : dispatches
    RestCommand --> MethodType

Requirements

• .NET 10 or higher
• Dependencies (resolved automatically via NuGet):
  • System.Reactive >= 6.1.0
  • Oakrey.Log >= 2.0.0

Installation

.NET CLI

dotnet add package Oakrey.Network.Rest

Package Manager Console

Install-Package Oakrey.Network.Rest

NuGet Package Manager

Search for Oakrey.Network.Rest in Visual Studio under Tools > NuGet Package Manager > Manage NuGet Packages for Solution.

Example usage

Basic HTTP calls

using Oakrey.Network.Rest;

using RestClient client = new();

string body = client.Get("https://api.example.com/items");
string created = client.Post("https://api.example.com/items", """{"name":"widget"}""");
string updated = client.Put("https://api.example.com/items/1", """{"name":"gadget"}""");
string deleted = client.Delete("https://api.example.com/items/1");

Command-object dispatch

RestCommand command = RestCommand.Post("https://api.example.com/items", """{"name":"widget"}""");
string result = client.SendData(command);

Observing responses and requests

// Subscribe to all HTTP responses
using IDisposable responseSub = client.Subscribe(response =>
{
    Console.WriteLine($"Response: {response.StatusCode}");
});

// Subscribe to all outgoing requests
using IDisposable requestSub = client.Requests.Subscribe(request =>
{
    Console.WriteLine($"Request: {request.Method} {request.RequestUri}");
});

Custom content type (JSON)

using RestClient jsonClient = new(new JsonRestSettings());
string response = jsonClient.Post("https://api.example.com/data", """{"key":"value"}""");

Configuration

Implement IRestSetting to provide a custom media type or encoding.

Development notes

• All HTTP calls use .Result to block synchronously on the Task. This is intentional for the current API shape; avoid calling these methods on a UI thread or inside an async context without wrapping in Task.Run.
• Both ReplaySubject<HttpRequestMessage> and ReplaySubject<HttpResponseMessage> are constructed with a buffer of 1, so a late subscriber receives the most recent item immediately.
• On any HTTP exception the error is logged via Oakrey.Log and responses.OnError is called, which terminates the response observable for that subscriber.

Project information

• Author: Oakrey
• License: MIT
• NuGet: Oakrey.Network.Rest
• Repository: Azure DevOps

License

MIT License. See the LICENSE file for details.