Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mayuki/Rin
Request/response Inspector middleware for ASP.NET Core
https://github.com/mayuki/Rin
Last synced: about 2 months ago
JSON representation
Request/response Inspector middleware for ASP.NET Core
- Host: GitHub
- URL: https://github.com/mayuki/Rin
- Owner: mayuki
- License: mit
- Created: 2018-08-01T14:36:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-03T15:49:51.000Z (10 months ago)
- Last Synced: 2024-10-11T09:55:03.489Z (2 months ago)
- Language: C#
- Homepage:
- Size: 4.7 MB
- Stars: 644
- Watchers: 15
- Forks: 24
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - mayuki/Rin - Request/response Inspector middleware for ASP.NET Core (C\#)
- awesome-reference-tools - Rin
README
# 
Rin
**R**equest/response **In**spector middleware for ASP.NET Core. like Glimpse.
[](https://github.com/mayuki/Rin/actions?query=workflow%3ABuild-Release)
[](https://github.com/mayuki/Rin/actions?query=workflow%3ABuild-Development)
[](https://badge.fury.io/nu/Rin)
Rin captures HTTP requests to ASP.NET Core app and provides viewer for captured data. It's useful tool to debug your Web application (e.g. Web sites, API apps).
# ✅ Features
## Capture requests and responses
Rin captures HTTP traffics between the ASP.NET Core app and any clients.
- Headers + Body
- Traces (`Microsoft.Extensions.Logging.ILogger`, log4net, ...)
- Unhandled Exception
## Inspect from Web browser in realtime
### View events timeline
Rin inspector displays events that occurred while processing a request.
### Preview a request/response body
Rin inspector can display request and response body with a preview. (e.g. JSON, Image, HTML, JavaScript ...)
### View related trace logs
Rin captures a request and response. Also, it captures logs while processing a request.
- Built-in `Microsoft.Extensions.Logging.ILogger` integration
- log4net Appender
### Save and export request/response
You can replay a request easily using cURL and LINQPad.
- Save request/response body
- Copy request as cURL and C#
### Integrate with ASP.NET Core MVC
- Record timings of view rendering and action execution
- In-View Inspector (like MiniProfiler)
# 📝 Requirements
- .NET Core 3.1+
- ASP.NET Core 3.1+
- Modern browser (e.g. Microsoft Edge, Google Chrome, Firefox, Safari...)
- WebSocket connectivity
# ⚡ QuickStart
## Install NuGet Package
### Using Visual Studio
`Dependencies` -> `Manage NuGet Packages...` -> Search and install `Rin` and `Rin.Mvc` (if your project is built with ASP.NET Core MVC) package.
### Using dotnet command
```
dotnet add package Rin
dotnet add package Rin.Mvc
```
### Using Package Manager
```
Install-Package Rin
Install-Package Rin.Mvc
```
## Setup and configure Rin
### Program.cs
```csharp
public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
WebHost.CreateDefaultBuilder(args)
.ConfigureLogging(configure =>
{
// Add: Enable Rin Logger
configure.AddRinLogger();
})
.UseStartup();
```
### Startup.cs
```csharp
public class Startup
{
...
public void ConfigureServices(IServiceCollection services)
{
...
services.AddControllersWithViews()
// Add(option): Enable ASP.NET Core MVC support if the project built with ASP.NET Core MVC
.AddRinMvcSupport();
// Add: Register Rin services
services.AddRin();
}
...
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
if (env.IsDevelopment())
{
// Add: Enable request/response recording and serve a inspector frontend.
// Important: `UseRin` (Middlewares) must be top of the HTTP pipeline.
app.UseRin();
// Add(option): Enable ASP.NET Core MVC support if the project built with ASP.NET Core MVC
app.UseRinMvcSupport();
app.UseDeveloperExceptionPage();
// Add: Enable Exception recorder. this handler must be after `UseDeveloperExceptionPage`.
app.UseRinDiagnosticsHandler();
}
...
}
}
```
### _Layout.cshtml (for ASP.NET Core MVC)
```cshtml
@inject Rin.Mvc.View.RinHelperService RinHelper
...
@* Add: Enable In-View Inspector for ASP.NET Core MVC *@
@RinHelper.RenderInViewInspector()
...
```
## Start the application and open Inspector on the web
Launch the app, then open `http://[Host:Port]/rin/` in the browser, you can see Rin Inspector now.
# 🔨 Develop and build Rin Inspector (client side)
Rin Inspector (client side) codes is separated from Rin core C# project. If you want to develop Rin (C#) or launch a sample project, you need to build and deploy the artifacts.
## [Rin.Frontend, Rin.Mvc.Frontend] Setup and start the development server
- `yarn`
- `yarn start`
## [Rin.Frontend] Build Rin/Resources.zip
- `yarn build`
- `yarn pack`
## [Rin.Mvc.Frontend] Build Rin.Mvc/EmbeddedResources
- `yarn build`
- `copy .\dist\static\main.js* ..\Rin.Mvc\EmbeddedResources\`
# License
[MIT License](LICENSE)