Meziantou.Framework.Http.Recording
1.0.2
Prefix Reserved
dotnet add package Meziantou.Framework.Http.Recording --version 1.0.2
NuGet\Install-Package Meziantou.Framework.Http.Recording -Version 1.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="Meziantou.Framework.Http.Recording" Version="1.0.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Meziantou.Framework.Http.Recording" Version="1.0.2" />
<PackageReference Include="Meziantou.Framework.Http.Recording" />
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 Meziantou.Framework.Http.Recording --version 1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Meziantou.Framework.Http.Recording, 1.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.
#:package Meziantou.Framework.Http.Recording@1.0.2
#: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=Meziantou.Framework.Http.Recording&version=1.0.2
#tool nuget:?package=Meziantou.Framework.Http.Recording&version=1.0.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Meziantou.Framework.Http.Recording
Meziantou.Framework.Http.Recording provides a DelegatingHandler to record and replay HttpClient traffic in tests.
Features
- Record and replay HTTP requests/responses with
HttpRecordingHandler - Configurable modes:
Record,Replay,Auto - Pluggable request matching (
IHttpRequestMatcher) - Pluggable entry sanitization (
IHttpRecordingSanitizer) - Built-in stores:
JsonHttpRecordingStore(JSON file)HarHttpRecordingStore(HAR 1.2 file)
Installation
dotnet add package Meziantou.Framework.Http.Recording
Basic usage (auto record + replay)
using Meziantou.Framework.Http.Recording;
var store = new HarHttpRecordingStore("http-recordings.har");
var options = new HttpRecordingOptions
{
Mode = HttpRecordingMode.Auto,
MissBehavior = HttpRecordingMissBehavior.Throw,
Sanitizer = new HeaderRemovalSanitizer("Authorization", "Cookie"),
};
using var innerHandler = new SocketsHttpHandler();
using var recordingHandler = new HttpRecordingHandler(innerHandler, store, options);
using var httpClient = new HttpClient(recordingHandler);
// First run calls the real endpoint and records the response.
var response1 = await httpClient.GetAsync("https://api.example.com/data");
// Later calls are replayed when a matching recording exists.
var response2 = await httpClient.GetAsync("https://api.example.com/data");
// Persist all recordings at the end of the test/session.
await recordingHandler.SaveAsync();
Replay-only mode
using Meziantou.Framework.Http.Recording;
var store = new JsonHttpRecordingStore("http-recordings.json");
var options = new HttpRecordingOptions
{
Mode = HttpRecordingMode.Replay,
MissBehavior = HttpRecordingMissBehavior.Throw,
};
using var recordingHandler = new HttpRecordingHandler(store, options);
using var httpClient = new HttpClient(recordingHandler);
var response = await httpClient.GetAsync("https://api.example.com/data");
Miss behavior
When no recorded response matches in replay mode:
Throw: throwsHttpRecordingMissExceptionReturnDefault: returns HTTP 500 with a diagnostic messagePassthrough: valid inAutomode, not inReplaymode
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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. 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
- Meziantou.Framework.HttpArchive (>= 1.0.1)
-
net8.0
- Meziantou.Framework.HttpArchive (>= 1.0.1)
-
net9.0
- Meziantou.Framework.HttpArchive (>= 1.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.