Bowire Documentation

Documentation

The reference manual for the multi-protocol API workbench: how to install it, how every pane of the UI works, how each protocol plugin behaves, and how to extend Bowire with your own protocols.

Where to start

New to Bowire? Take the Bowire Bootcamp — a hands-on walkthrough from your first call through recording, mocks, AI integration, and authoring your own protocol plugin. Picks up where the Quickstart leaves off and lands in a capstone project. The pages below are the reference you reach for after the Bootcamp.

Three entry points depending on what you need:

  • Setup — the one place for install instructions. Embedded in your ASP.NET app, standalone CLI, sidecar container, or building from source.
  • User Guide — the full manual for the browser UI. Every pane, every action, every feature with screenshots.
  • API Reference — types, methods, and extension points generated from the source.

Reference material is split further:

  • Protocol Guides — behaviour and setup for each protocol plugin (gRPC, REST, GraphQL, SignalR, WebSocket, SSE, MQTT, Socket.IO, OData, MCP) plus how to write your own.
  • Architecture — internals, the plugin pipeline, discovery, and data locations — for anyone extending or embedding Bowire deeply.

Runnable examples next to the references:

  • Samples — one self-contained reference app per protocol (REST / gRPC / GraphQL / MQTT / SignalR / SocketIO / SSE / WebSocket / OData / MCP) plus a Combined showcase, all built around the same Harbor Control Center domain. Source at Kuestenlogik/Bowire.Samples. Useful when you want to see a wire end-to-end before wiring it into your own service.

About these docs

These pages cover the application itself — the CLI, the embedded host integration, and every panel of the browser UI.

Every tagged release on GitHub ships a versioned offline snapshot of these docs (HTML zip + single-file PDF) so you can pin to a specific version or browse offline.

Edit this page