MVFC.DataX.Readers.Http
1.2.0
dotnet add package MVFC.DataX.Readers.Http --version 1.2.0
NuGet\Install-Package MVFC.DataX.Readers.Http -Version 1.2.0
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="MVFC.DataX.Readers.Http" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="MVFC.DataX.Readers.Http" Version="1.2.0" />
<PackageReference Include="MVFC.DataX.Readers.Http" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add MVFC.DataX.Readers.Http --version 1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: MVFC.DataX.Readers.Http, 1.2.0"
#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.
#:package MVFC.DataX.Readers.Http@1.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=MVFC.DataX.Readers.Http&version=1.2.0
#tool nuget:?package=MVFC.DataX.Readers.Http&version=1.2.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
MVFC.DataX.Readers.Http
HTTP API Reader for MVFC.DataX. Seamlessly read bulk JSON arrays or use modern IAsyncEnumerable<T> streaming API integrations from your Data Pipelines.
This package is part of the MVFC.DataX suite. For the full documentation and more examples, please check the main repository README.
Installation
dotnet add package MVFC.DataX.Readers.Http
Available Classes
| Class | Description |
|---|---|
HttpApiReader<T> |
Supports generating streams out of API HTTP responses via HttpClient (bulk) or HTTP streaming protocols. |
API Signatures
// Constructor for fetching a collection all at once (bulk mapping)
public HttpApiReader(Func<CancellationToken, Task<IEnumerable<T>>> fetch)
// Constructor for consuming an API streaming protocol natively
public HttpApiReader(Func<CancellationToken, IAsyncEnumerable<T>> fetch)
Usage / Example
Example 1: Standard REST API Call (Bulk)
using System.Net.Http.Json;
using MVFC.DataX.Pipeline;
using MVFC.DataX.Readers.Http;
var httpClient = new HttpClient { BaseAddress = new Uri("https://api.example.com") };
// 1. Setup the HTTP Reader
var reader = new HttpApiReader<User>(
// Note: This lambda will execute once and buffer the full IEnumerable
// to then stream items to the pipeline.
async ct => await httpClient.GetFromJsonAsync<IEnumerable<User>>("/users", ct)
);
// 3. Orchestrate with PipelineBuilder
var pipeline = PipelineBuilder.ReadFrom(reader)
.WriteTo(myWriter)
.Build();
await pipeline.RunAsync(cancellationToken);
Example 2: Streaming HTTP (High Performance)
using System.Net.Http.Json;
using MVFC.DataX.Pipeline;
using MVFC.DataX.Readers.Http;
var httpClient = new HttpClient { BaseAddress = new Uri("https://api.example.com") };
// 1. Setup the HTTP Reader with streaming
var reader = new HttpApiReader<User>(
// Using Refit or .NET native GetFromJsonAsAsyncEnumerable handles
// partial chunks gracefully
ct => httpClient.GetFromJsonAsAsyncEnumerable<User>("/users/stream", cancellationToken: ct)
);
var pipeline = PipelineBuilder.ReadFrom(reader)
.WriteTo(myWriter)
.Build();
await pipeline.RunAsync(cancellationToken);
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- MVFC.DataX.Core (>= 1.2.0)
-
net9.0
- MVFC.DataX.Core (>= 1.2.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.