pmilet.Playback 1.0.9

There is a newer version of this package available.
See the version list below for details.
dotnet add package pmilet.Playback --version 1.0.9
NuGet\Install-Package pmilet.Playback -Version 1.0.9
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="pmilet.Playback" Version="1.0.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add pmilet.Playback --version 1.0.9
#r "nuget: pmilet.Playback, 1.0.9"
#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 pmilet.Playback as a Cake Addin
#addin nuget:?package=pmilet.Playback&version=1.0.9

// Install pmilet.Playback as a Cake Tool
#tool nuget:?package=pmilet.Playback&version=1.0.9

Asp.Net Core Playback

An Asp.Net Core middleware library that simplifies the recording and playback of api calls by means of a simple playback identifier. Suitable for saving user interactions in production in order to be replayed locally, anytime and in isolation.

How to record incoming Api requests

Once your Asp.NetCore Api is configured for playback ( see sample in github repo ) you can start recording and replaying Api requests

When the X-Playback-Mode request header is set to Record the request will be saved.

curl -X GET --header 'Accept: text/plain' --header 'X-Playback-Mode: Record' 'http://apigatewaysample.azurewebsites.net/api/Hello/hello'

then a x-playback-id response header will be received.

Response Headers { "date": "Wed, 25 Oct 2017 21:05:46 GMT", "content-encoding": "gzip", "server": "Kestrel", "x-powered-by": "ASP.NET", "vary": "Accept-Encoding", "content-type": "text/plain; charset=utf-8", "transfer-encoding": "chunked", "x-playback-id": "_ApiGateway+Sample_v1.0_Hello%252Fhello_GET_757602046" }

When the X-Playback-Mode request header is set to Playback the request will be replayed; you should also set the x-playback-id request header with the value received during recording.

curl -X GET --header 'Accept: text/plain' --header 'X-Playback-Id: _ApiGateway+Sample_v1.0_Hello%252Fhello_GET_757602046' --header 'X-Playback-Mode: Playback' 'http://apigatewaysample.azurewebsites.net/api/Hello/bye'

Notice that the response is exactly the same has before.

When setting the x-playback-mode to None the request is not saved neither replayed.

How to record responses received from outgoing requests

For recording responses from outgoing requests you should use the PlaybackContext class that can be injected in your api proxies.

this code excerpt show how you can save a response received from an outgoing api call

       var response = await httpClient.GetAsync(url);
       var result = await response.Content.ReadAsStringAsync();
       if (_playbackContext.IsRecord)
            {
                await _playbackContext.RecordResult<MyServiceResponse>(result);
            }
            else if ( _playbackContext.IsPlayback )
            {
                return await _playbackContext.PlaybackResult<MyServiceResponse>();
            }     

How to fake api responses

For faking api call responses implement a class that inherits from IFakeFactory.

in this code excerpt we create a factory by inheriting from the FakeFactoryBase abstract class.

public class MyPlaybackFakeFactory : FakeFactoryBase
    {
        public override void GenerateFakeResponse(HttpContext context)
        {
            switch (context.Request.Path.Value.ToLower())
            {
                case "/api/hello":
                    if (context.Request.Method == "POST")
                        GenerateFakeResponse<HelloRequest, string>(context, HelloPost);
                    else if (context.Request.Method == "GET")
                        GenerateFakeResponse<string, string>(context, HelloGet);
                    break;
                default:
                    throw new NotImplementedException("fake method not found");
            }
        }

Note: this class should be registered in the Startup class IoC Container as IFakeFactory

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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 netcoreapp1.1 is compatible.  netcoreapp2.0 is compatible.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net452 is compatible.  net46 was computed.  net461 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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.2.2 1,590 4/1/2019
1.2.1 1,179 2/19/2018
1.2.0 1,028 2/19/2018
1.1.2 1,114 1/23/2018
1.1.1 1,203 1/23/2018
1.1.0 1,043 1/23/2018
1.0.10 1,983 10/27/2017
1.0.9 1,462 10/25/2017
1.0.8 1,105 10/25/2017
1.0.7 1,264 10/22/2017
1.0.6 1,041 10/21/2017
1.0.5 978 10/21/2017
1.0.4 982 10/21/2017
1.0.3 962 10/18/2017
1.0.2 953 10/18/2017
1.0.1 963 10/18/2017
1.0.0 840 10/15/2017

new file storage service