Request.Body.Peeker
1.1.0
See the version list below for details.
dotnet add package Request.Body.Peeker --version 1.1.0
NuGet\Install-Package Request.Body.Peeker -Version 1.1.0
<PackageReference Include="Request.Body.Peeker" Version="1.1.0" />
paket add Request.Body.Peeker --version 1.1.0
#r "nuget: Request.Body.Peeker, 1.1.0"
// Install Request.Body.Peeker as a Cake Addin #addin nuget:?package=Request.Body.Peeker&version=1.1.0 // Install Request.Body.Peeker as a Cake Tool #tool nuget:?package=Request.Body.Peeker&version=1.1.0
Peeking at HttpContext.Request.Body, without consuming it
Usage
Install it from Nuget
Check out the source code from Github
Install-Package Request.Body.Peeker -Version 1.0.0
After installation you can read the HttpContext request body without consuming it as follows
//Return string
var request = context.HttpContext.Request.PeekBody();
//Return in expected type
LoginRequest request = context.HttpContext.Request.PeekBody<LoginRequest>();
//Return in expected type asynchronously
LoginRequest request = await context.HttpContext.Request.PeekBodyAsync<LoginRequest>();
We are happy with the .Net core's Middlewares and ActionFilters. They provide us with a moment with the HTTP request to check the JWT validity or ApiKey with ease but as far as the parameters which we are interested are located in the HTTP header or the query string. As soon as we need to check a value in the request body we start facing some weird issues.
A stream is like a one-time message, it will be gone, as soon as you read it.
The HttpContext.Request.Body is also a stream, by reading it in middleware 1 , you will end up with an empty stream in the MVC middleware if the pipeline's order is as follows :
Middleware 1 -> MVC Middleware
The known solution is to read the stream and then put back in its place.
var request = HttpContext.Request;
request.EnableBuffering();
var buffer = new byte[Convert.ToInt32(request.ContentLength)];
request.Body.Read(buffer, 0, buffer.Length);
By enabling the buffering mode on the HttpContext request body stream we can read the cloned version of the stream from the memory. After we have finished with the reading we must set the stream position pointer to the beginning again like this
request.Body.Position = 0;
Writing all above code, or having a helper class in each project to take care of it can be annoying. That's why i have put together a Nuget extension to the HttpRequest class to take care of all this behind the scene.
Install it from Nuget
Check out the source code from Github
Happy coding.
Product | Versions 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 | netcoreapp2.0 was computed. 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 | net461 was computed. 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. |
-
.NETStandard 2.0
- Microsoft.AspNetCore.Http (>= 2.2.2)
- Newtonsoft.Json (>= 12.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (1)
Showing the top 1 popular GitHub repositories that depend on Request.Body.Peeker:
Repository | Stars |
---|---|
Letterbook/Letterbook
Sustainable federated social media built for open correspondence
|
support generic parsin , async , sync