Bruno allows you to automatically generate a standalone HTML documentation file from your collection. This creates a shareable, interactive API documentation page that you can deploy anywhere or share with your team.
Generate Documentation
- Navigate to the Collection Settings and click on the Generate Docs under Documentation section
- Select Environment to include in the documentation and click the Generate button to create the HTML documentation
Optional: You can set a collection version before generating docs. Collections without a version show “Not set”.
- Bruno will generate a documentation file for your collection in your file system with name
collection-name-documentation.html
Key Features
Environment Support
Use the topbar environment switcher to pick an active environment, and turn on Show vars to resolve {{var}} placeholders across URLs, headers, body, and code snippets.
- Resolves collection and global variables against the active environment
- Switch environments without reloading the page
- Secret variables stay masked even when Show variables is on
- Environment and toggle preferences persist for that docs file across refreshes
Search Capability
Click the search bar in the header or press ⌘K / Ctrl+K to open the search palette. Press Escape or the close button to dismiss it.
- Searches across request name, URL, params, and description
- Results show HTTP method badge, request name, folder breadcrumb, and resolved URL
- Filter by method using GET / POST / PUT / DEL chips
- Filter by folder to narrow results to a specific part of the collection
- Clear all resets both the query and all active filters
- Selecting a result navigates directly to that request’s page
Interactive Playground
Click on Try button at request level to get interactive playground that allows users to:
- Edit request parameters, headers, and body
- Modify and test scripts in real-time
- Execute requests live directly from the documentation
- View responses immediately
Code Samples
The documentation automatically generates code snippets for each request in multiple languages:
- cURL
- Python (requests)
- JavaScript
Tests and Scripts Display
Interactive playground supports to:
- Show pre and post request scripts inline for each request
- Display Params, Variables, Body, Headers, Auth and test logic
- View Tests and Assertions directly in the documentation
Deployment Options
Once generated, you can:
- Open locally: View the HTML file in any browser
- Static hosting: Deploy to GitHub Pages, Netlify, Vercel, or any static host
- Share directly: Send the HTML file to team members or API consumers
- Documentation portal: Add to your developer portal or docs site
