DotNetWorkQueue.Dashboard.Api 0.9.38 (original) (raw)

• README
• Frameworks
• Dependencies
• Used By
• Versions
• Release Notes

REST API for monitoring and managing DotNetWorkQueue queues.

Features

• Queue status and message listing with filtering
• Message detail views including body, headers, and error info
• Error message requeue (individual and bulk)
• Stale message reset (individual and bulk)
• Message body editing
• Swagger/OpenAPI documentation
• Optional API key authentication
• Supports all 6 transports: SQL Server, PostgreSQL, SQLite, Redis, LiteDB, Memory
• Targets .NET 10.0, .NET 8.0

Installation

dotnet add package DotNetWorkQueue.Dashboard.Api

Quick Start

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDashboardApi(builder.Configuration);
var app = builder.Build();
app.MapDashboardApi();
app.Run();

Deployment

Important: The Dashboard API is designed for internal use only. Deploy it behind a VPN, firewall, or reverse proxy that restricts access to authorized operators.

Infrastructure Concerns (not handled by the API):

• HTTPS/TLS -- Terminate TLS at your reverse proxy (nginx, HAProxy, AWS ALB)
• Rate limiting -- Configure at the infrastructure layer
• Authentication -- Use the built-in API key (ApiKey option) or configure an ASP.NET Core authorization policy (AuthorizationPolicy option)
• CORS -- Configure allowed origins via EnableCors and CorsOrigins options when the Blazor UI runs on a different origin

**Health Check:**The API exposes a health check endpoint at /api/v1/dashboard/health for use with load balancers and monitoring systems. Returns HTTP 200 when healthy with uptime and connection count data.

Documentation

• Wiki
• GitHub Repository

License

LGPL-2.1-or-later

• net10.0

  • DotNetWorkQueue (>= 0.9.38)
  • DotNetWorkQueue.Transport.LiteDb (>= 0.9.38)
  • DotNetWorkQueue.Transport.PostgreSQL (>= 0.9.38)
  • DotNetWorkQueue.Transport.Redis (>= 0.9.38)
  • DotNetWorkQueue.Transport.RelationalDatabase (>= 0.9.38)
  • DotNetWorkQueue.Transport.Shared (>= 0.9.38)
  • DotNetWorkQueue.Transport.SQLite (>= 0.9.38)
  • DotNetWorkQueue.Transport.SqlServer (>= 0.9.38)
  • Swashbuckle.AspNetCore (>= 10.1.7)

• net8.0

  • DotNetWorkQueue (>= 0.9.38)
  • DotNetWorkQueue.Transport.LiteDb (>= 0.9.38)
  • DotNetWorkQueue.Transport.PostgreSQL (>= 0.9.38)
  • DotNetWorkQueue.Transport.Redis (>= 0.9.38)
  • DotNetWorkQueue.Transport.RelationalDatabase (>= 0.9.38)
  • DotNetWorkQueue.Transport.Shared (>= 0.9.38)
  • DotNetWorkQueue.Transport.SQLite (>= 0.9.38)
  • DotNetWorkQueue.Transport.SqlServer (>= 0.9.38)
  • Microsoft.Extensions.Configuration.Binder (>= 10.0.8)
  • Swashbuckle.AspNetCore (>= 10.1.7)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on DotNetWorkQueue.Dashboard.Api:

GitHub repositories

This package is not used by any popular GitHub repositories.