HubDocs 0.0.5

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package HubDocs --version 0.0.5
                    


                    

                
NuGet\Install-Package HubDocs -Version 0.0.5
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="HubDocs" Version="0.0.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="HubDocs" Version="0.0.5" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="HubDocs" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add HubDocs --version 0.0.5
                    


                    

                
#r "nuget: HubDocs, 0.0.5"
#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. 
#:package HubDocs@0.0.5
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=HubDocs&version=0.0.5
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=HubDocs&version=0.0.5
                    


                            Install as a Cake Tool

HubDocs

A Swagger-like UI for exploring and documenting SignalR hubs in ASP.NET Core applications.

Features

  • 🔍 Automatic discovery of SignalR hubs and strongly-typed client interfaces
  • 📝 Method documentation with parameters and return types
  • 🎨 Beautiful Swagger-inspired dark theme UI
  • 🔌 Easy integration with minimal configuration
  • 📡 Live view of client method invocations from server (via strongly-typed interfaces)

Screenshots

Screenshot Screenshot Screenshot

HubDocs UI showing SignalR hubs and their methods

Installation

dotnet add package HubDocs

Quick Start

  1. Add HubDocs to your ASP.NET Core application:
using HubDocs;

var builder = WebApplication.CreateBuilder(args);
// ... your other configurations ...

var app = builder.Build();

//Configure and register hub
app.MapHubAndRegister<YourHub>("/hub");

// Configure HubDocs middleware
app.AddHubDocs();

// ... your other middleware configurations ...
  1. Access the HubDocs UI at /hubdocs/index.html or /hubdocs/ in your browser.

Example

public interface IChatClient
{
    Task ReceiveMessage(string user, string message);
    Task Connected(string connectionId);
}

public class ChatHub : Hub<IChatClient>
{
    public async Task SendMessage(string user, string message)
    {
        await Clients.All.ReceiveMessage(user, message);
    }

    public override async Task OnConnectedAsync()
    {
        await Clients.Caller.Connected(Context.ConnectionId);
    }
}

Note: To fully leverage HubDocs, your hubs should implement Hub<T> with a strongly-typed client interface (T) that defines the client-callable methods. HubDocs will automatically extract and render both hub and client method metadata in the UI.

HubDocs will automatically discover and display:

  • Hub name and full type name
  • All public methods with parameters and return types
  • Interactive UI for exploring the hub

Configuration

Register hubs:

app.MapHubAndRegister<ChatHub>("/hubs/chat");

app.AddHubDocs();
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows 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
0.0.5 121 6/21/2025
0.0.4 269 6/9/2025
0.0.3 239 6/9/2025
0.0.2 121 6/6/2025
0.0.2-alpha 116 6/6/2025
0.0.1 116 6/6/2025