diff --git a/DebugProbe.AspNetCore/README.md b/DebugProbe.AspNetCore/README.md index d688b97..819826c 100644 --- a/DebugProbe.AspNetCore/README.md +++ b/DebugProbe.AspNetCore/README.md @@ -1,20 +1,16 @@ -# DebugProbe.AspNetCore +# DebugProbe.AspNetCore -Debug HTTP traffic directly inside your ASP.NET Core pipeline. +DebugProbe.AspNetCore is a lightweight ASP.NET Core debugging tool for inspecting HTTP traffic directly inside your application. -[DebugProbe Website](https://debugprobe.dev) +It captures request and response data, exposes a local dashboard, and helps compare traces during API development without requiring a proxy, browser extension, or external SaaS service. ---- +## Links -## Why DebugProbe? - -- Inspect requests and responses in real time -- No proxies or external tools -- Built-in request tracing UI -- Compare responses across environments -- Minimal setup for ASP.NET Core applications - ---- +- Website: [debugprobe.dev](https://debugprobe.dev) +- Documentation: [debugprobe.dev/docs](https://debugprobe.dev/docs) +- Live demo: [demo.debugprobe.dev/debug](https://demo.debugprobe.dev/debug) +- Demo API: [demo.debugprobe.dev/swagger](https://demo.debugprobe.dev/swagger) +- NuGet: [DebugProbe.AspNetCore](https://www.nuget.org/packages/DebugProbe.AspNetCore) ## Install @@ -22,8 +18,6 @@ Debug HTTP traffic directly inside your ASP.NET Core pipeline. dotnet add package DebugProbe.AspNetCore ``` ---- - ## Quick Start ```csharp @@ -32,14 +26,12 @@ builder.Services.AddDebugProbe(); app.UseDebugProbe(); ``` -Open: +Start your application and open: ```txt http://localhost:{port}/debug ``` ---- - ## Optional Configuration ```csharp @@ -61,56 +53,44 @@ builder.Services.AddDebugProbe(options => app.UseDebugProbe(); ``` ---- - ## Features -- Request and response inspection -- Headers, query params, and body capture -- Response comparison across environments -- JSON formatting +- Request inspection +- Response inspection +- Headers, query string, and body capture +- Error visibility +- Local debugging dashboard +- Trace comparison across runs or environments +- JSON formatting for captured payloads - Configurable body capture limits -- Ignore noisy endpoints +- Ignored path configuration for noisy or sensitive endpoints - Sensitive header masking - ---- +- Outgoing `HttpClient` request tracing ## Security Defaults -Sensitive headers are automatically masked: - -- Authorization -- Cookie -- Set-Cookie - -Localhost compare targets are blocked by default. - ---- +DebugProbe masks common sensitive headers automatically: -## Production Usage +- `Authorization` +- `Cookie` +- `Set-Cookie` -DebugProbe is intended primarily for development environments. +## Intended Usage -If used in production: +DebugProbe is designed primarily for local development and controlled development environments. -- add authentication -- restrict access -- filter sensitive data +If you use it outside local development, protect the dashboard with authentication, restrict network access, and avoid capturing sensitive endpoints or payloads. ---- +## Documentation -## Documentation & Demo +For full setup details, screenshots, dashboard behavior, configuration options, and live examples, see the documentation: -Visit the website for: -- latest screenshots -- demos -- guides -- updates +[https://debugprobe.dev/docs](https://debugprobe.dev/docs) -https://debugprobe.dev +## Contributing ---- +Contributions are welcome. Please read [CONTRIBUTING.md](https://github.com/DebugProbe/DebugProbe.AspNetCore?tab=contributing-ov-file) before opening an issue or pull request. ## License -Apache License 2.0 \ No newline at end of file +DebugProbe.AspNetCore is licensed under the [Apache License 2.0](https://github.com/DebugProbe/DebugProbe.AspNetCore/blob/main/LICENSE). diff --git a/README.md b/README.md index d688b97..18b58f9 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,16 @@ # DebugProbe.AspNetCore -Debug HTTP traffic directly inside your ASP.NET Core pipeline. +DebugProbe.AspNetCore is a lightweight ASP.NET Core debugging tool for inspecting HTTP traffic directly inside your application. -[DebugProbe Website](https://debugprobe.dev) +It captures request and response data, exposes a local dashboard, and helps compare traces during API development without requiring a proxy, browser extension, or external SaaS service. ---- +## Links -## Why DebugProbe? - -- Inspect requests and responses in real time -- No proxies or external tools -- Built-in request tracing UI -- Compare responses across environments -- Minimal setup for ASP.NET Core applications - ---- +- Website: [debugprobe.dev](https://debugprobe.dev) +- Documentation: [debugprobe.dev/docs](https://debugprobe.dev/docs) +- Live demo: [demo.debugprobe.dev/debug](https://demo.debugprobe.dev/debug) +- Demo API: [demo.debugprobe.dev/swagger](https://demo.debugprobe.dev/swagger) +- NuGet: [DebugProbe.AspNetCore](https://www.nuget.org/packages/DebugProbe.AspNetCore) ## Install @@ -22,8 +18,6 @@ Debug HTTP traffic directly inside your ASP.NET Core pipeline. dotnet add package DebugProbe.AspNetCore ``` ---- - ## Quick Start ```csharp @@ -32,14 +26,12 @@ builder.Services.AddDebugProbe(); app.UseDebugProbe(); ``` -Open: +Start your application and open: ```txt http://localhost:{port}/debug ``` ---- - ## Optional Configuration ```csharp @@ -61,56 +53,44 @@ builder.Services.AddDebugProbe(options => app.UseDebugProbe(); ``` ---- - ## Features -- Request and response inspection -- Headers, query params, and body capture -- Response comparison across environments -- JSON formatting +- Request inspection +- Response inspection +- Headers, query string, and body capture +- Error visibility +- Local debugging dashboard +- Trace comparison across runs or environments +- JSON formatting for captured payloads - Configurable body capture limits -- Ignore noisy endpoints +- Ignored path configuration for noisy or sensitive endpoints - Sensitive header masking - ---- +- Outgoing `HttpClient` request tracing ## Security Defaults -Sensitive headers are automatically masked: - -- Authorization -- Cookie -- Set-Cookie - -Localhost compare targets are blocked by default. - ---- +DebugProbe masks common sensitive headers automatically: -## Production Usage +- `Authorization` +- `Cookie` +- `Set-Cookie` -DebugProbe is intended primarily for development environments. +## Intended Usage -If used in production: +DebugProbe is designed primarily for local development and controlled development environments. -- add authentication -- restrict access -- filter sensitive data +If you use it outside local development, protect the dashboard with authentication, restrict network access, and avoid capturing sensitive endpoints or payloads. ---- +## Documentation -## Documentation & Demo +For full setup details, screenshots, dashboard behavior, configuration options, and live examples, see the documentation: -Visit the website for: -- latest screenshots -- demos -- guides -- updates +[https://debugprobe.dev/docs](https://debugprobe.dev/docs) -https://debugprobe.dev +## Contributing ---- +Contributions are welcome. Please read [CONTRIBUTING.md](https://github.com/DebugProbe/DebugProbe.AspNetCore?tab=contributing-ov-file) before opening an issue or pull request. ## License -Apache License 2.0 \ No newline at end of file +DebugProbe.AspNetCore is licensed under the [Apache License 2.0](https://github.com/DebugProbe/DebugProbe.AspNetCore/blob/main/LICENSE).