APIs Documentation

Bruno allows you to create API documentation at four distinct levels: Workspace, Collection, Folder, and Request.

With full Markdown support you can write clear, concise, and well-structured documentation at each level supplemented with any relevant screenshots, gifs, or other elements to ensure your users have a seamless onboarding experience.

Bruno sanitizes all HTML in documentation blocks before rendering. This prevents cross-site scripting (XSS) attacks when previewing markdown that contains embedded HTML. Elements like script tags and inline event handlers are automatically removed.

Although Collections are the machine-readable instructions for interacting with an API, offering human-readable instructions to your users can significantly reduce the time to their first interaction.

Create Documentation

1. Document a workspace
2. Document a collection
3. Document a folder
4. Document a request

Auto Generate Documentation

Bruno can automatically generate a standalone HTML documentation file for your entire collection. This allows you to quickly create and deploy professional-looking API documentation.

Learn how to auto-generate docs