bru import options
bru import takes the specification type first, then options that choose the source, the output location, and the on-disk layout of the collection:
bru import <type> [options]
<type> is openapi or wsdl. To view the options available in your installed version:
bru import openapi -h
bru import wsdl -h
The other commands document their options on their own pages: bru run and bru docs.
Options
| Option | Details |
|---|---|
-s, --source [string] |
Path or URL to the specification (OpenAPI YAML or JSON, or WSDL) |
-o, --output [string] |
Output directory for a collection on disk (folder import) |
-f, --output-file [string] |
Output file path for a single Bruno collection JSON export |
-n, --collection-name [string] |
Name for the imported collection |
--collection-format [string] |
OpenAPI folder import only: bru (classic .bru files) or opencollection (OpenCollection YAML). Default: opencollection. |
--insecure |
Skip TLS verification when --source is an https:// URL |
-g, --group-by [string] |
OpenAPI only: group requests by tags or path (default: tags) |
Use --output to write a collection to a directory, or --output-file to write a single collection JSON export. For directory imports, --collection-format chooses between OpenCollection YAML (the default) and classic .bru files.
Next Steps
- Import Collections - Worked examples for OpenAPI and WSDL imports with the options above
- bru run - Run the collection you just imported
- bru docs - Generate HTML API documentation from it