Use case · API documentation

Docs that live wherever your team already looks

Generate a standalone HTML site from your Bruno collection, then put it exactly where people need it: a public portal, an internal wiki, or a private link. It's one file, so it goes almost anywhere.

acme-api-docs.html
Acme API
Introduction
▾ Users
GET /users
POST /users
▾ Orders
GET /v1/users
cURLPythonJS
curl https://api.acme.dev/v1/users
200 OK · application/json
One file, anywhere

Put your docs where the readers are

Because the output is a single self-contained HTML file, you decide where it goes, with no docs platform dictating the answer.

Public documentation

Publish to a custom domain on GitHub Pages, Netlify, or Vercel so partners and customers can integrate on their own.

Internal developer portal

Drop it into Backstage, a docs hub, or an intranet page so every internal team hits the same reference.

Private & internal-only

Keep it behind your VPN or auth. Since it's a static file, it runs anywhere you can serve one, with no external service to trust.

A single file to share

Send it to a contractor, attach it to a ticket, or open it locally in a browser. No build step, no runtime.

How it works

Generated from the collection you already maintain

1

Generate from your collection

Bruno renders your folders, requests, and environments straight into HTML. Nothing new to write.

2

Regenerate when the API changes

Docs come from the source of truth, so they stay honest, with no parallel spec drifting out of date.

3

Host it wherever you chose

Copy the file to your static host or portal. That's the whole deployment.

What's inside

More than a reference: something people can use

Copy-ready code samples

Every request ships with cURL, Python, and JavaScript, so readers can call the API in seconds.

Tests & scripts in context

Pre-request and post-response logic is documented inline: the real behaviour, not a summary.

A live “Try It Out” panel

Readers can edit and execute requests right from the page and see real responses.

Turn your collection into docs worth publishing

Generate a self-hosted HTML docs site in one click, then host it anywhere.