Skip to content

Introduction

NestJS has @nestjs/swagger for REST. Socket.IO gateways have nothing.

wsgate fills that gap — an interactive browser UI like Swagger UI, but for your WebSocket events. Decorate your gateway handlers with @WsDoc() and get an interactive UI to emit events, inspect payloads, and watch live responses without writing a single test client.

Features

  • Decorator-driven — metadata collected at decoration time, zero DI scanning
  • Interactive UI — emit events and inspect responses in real time
  • Monaco Editor — JSON payload editing with validation and faker support
  • Code generation — generate client code in 9+ languages
  • Multi-namespace — groups events by namespace automatically
  • Zero config — one line in main.ts, no root module changes

Packages

PackageDescription
@wsgate/nestNestJS adapter — decorators, module
@wsgate/expressExpress adapter — decorators, module
@wsgate/uiReact UI — served automatically by @wsgate/nest

Released under the MIT License.