Workflow · Documentation teams

Runnable examples next to the words

Your API reference deserves more than a curl block readers can’t edit. Bowire gives each example a method picker, a typed editor, and a real response.

Embed the Bowire UI inside your own Jekyll / docfx / MkDocs site, or link out to a hosted standalone. Every example is live, every response matches production behaviour, every call exports to curl / grpcurl / C# / TypeScript.

Embed inside your docs site

Drop Bowire next to the prose. Readers click a method, tweak the request, see the real response — no “copy this, paste into terminal, adjust the token” round-trip.

One <iframe> per example

Point each embed at the specific method you’re documenting. Bowire renders the request editor + response pane for just that method — no sidebar, no clutter.

Works with any static-site generator. The embedded Bowire instance can hit a sandbox endpoint you already have (auth pre-filled via URL params) or a per-reader replay-mock if you don’t want live traffic to touch the docs. The UI honours your docs site’s theme via CSS variables — light / dark flip automatically.

Embedded setup docs →
Request editor with response pane showing a real API response Request editor with response pane showing a real API response

Copy-paste in every language

Readers don’t all write C#. Bowire regenerates the current request as curl, grpcurl, and typed C# / TypeScript snippets, live as you edit.

Every edit updates every snippet

Change a field in the form editor — the curl block, the grpcurl command, the C# client code, and the TypeScript fetch-wrapper all regenerate in place.

No stale docs. The snippet you’re about to paste reflects exactly what you just configured in the UI: the current URL, the current auth header, the current body, the current headers. Copy-to-clipboard on any snippet; readers keep the thing that worked for them.

Export / import docs →
Command palette and method picker — searching across every documented method Command palette and method picker — searching across every documented method

Work offline from a schema

Your docs team shouldn’t need a running staging server to write the API reference. Upload the schema and browse the full surface.

Drop in a .proto / OpenAPI spec / GraphQL SDL

Bowire renders the full method tree from the schema alone — no live backend required for writing, reviewing, or linting the reference.

Great for contract-review PRs, for writing docs before the backend ships, for onboarding a writer who doesn’t have staging credentials, and for producing screenshots that don’t depend on a flaky shared environment. Supports buf-style imports, OpenAPI 3 / Swagger 2, and GraphQL SDL; additional formats via plugin.

Offline schema mode →
Upload a .proto / OpenAPI / GraphQL SDL and browse the API surface offline Upload a .proto / OpenAPI / GraphQL SDL and browse the API surface offline

Turn the reference into a playground

Runnable examples, per-language exports, offline-from-schema authoring — no SaaS, no account, MIT-licensed.

Go to the export & import docs