Last updated

bundle

Introduction

API descriptions can grow and become difficult to manage, especially if several teams are collaborating on them. It's a good practice to maintain the reusable parts as separate files, and include them in the main (root) API description by referencing them with $ref. However, most OpenAPI tools don't support that multi-file approach, and require a single-file API description.

Redocly CLI can help you combine separate API description files (such as if you used the split command) into one. The bundle command pulls the relevant parts of an API description into a single file output in JSON or YAML format.

The bundle command first executes preprocessors, then rules, then decorators.

Usage

redocly bundle <apis>...
redocly bundle <apis> [--remove-unused-components]
redocly bundle <apis> [--config=<path>]
redocly bundle <apis>... -o <outputName> --ext <ext>
redocly bundle --version

Options

Important

The --lint switch and all related options (--extends, --max-problems, --skip-rule, --format) are deprecated and are marked for removal in future releases. Use the lint command separately to lint your APIs before bundling.

OptionTypeDescription
apis[string]List of API description root filenames or names assigned in the apis section of your Redocly configuration file. Default values are all names defined in the apis section within your configuration file.
--configstringSpecify path to the config file.
--dereferenced, -dbooleanGenerate fully dereferenced bundle.
--extstringSpecify bundled file extension. Possible values are json, yaml, or yml. Default value is yaml.
--extends (Deprecated)[string]Can be used in combination with --lint to extend a specific configuration. Default values are taken from the Redocly configuration file.
--force, -fbooleanGenerate bundle output even when errors occur.
--format (Deprecated)stringFormat for the output. Possible values are codeframe, stylish, json, or checkstyle. Default value is codeframe.
--helpbooleanShow help.
--keep-url-references, -kbooleanKeep absolute url references.
--lint (Deprecated)booleanLint API description files. Default value is false.
--lint-configstringSpecify the severity level for the configuration file.
Possible values: warn, error, off. Default value is warn.
--max-problems (Deprecated)integerTruncate output to display the specified maximum number of problems. Default value is 100.
--metafilestringPath for the bundle metadata file.
--output, -ostringName or folder for the bundle file. If you don't specify the file extension, .yaml is used by default. If the specified folder doesn't exist, it's created automatically. If the file specified as the bundler's output already exists, it's overwritten.
--remove-unused-componentsbooleanRemove unused components from the bundle output.
--skip-decorator[string]Ignore certain decorators. See the Skip preprocessor, rule, or decorator section.
--skip-preprocessor[string]Ignore certain preprocessors. See the Skip preprocessor, rule, or decorator section.
--skip-rule (Deprecated)[string]Ignore certain rules. See the Skip preprocessor, rule, or decorator section.
--versionbooleanShow version number.

Examples

Bundle a single API description

This command creates a bundled file at the path dist/openapi.json starting from the root API description file openapi/openapi.yaml and following the $ref to other files if appropriate. The bundled file is in JSON format.

redocly bundle openapi/openapi.yaml --output dist/openapi.json

Bundle multiple API descriptions

This command creates one bundled file for each of the specified apis in the dist/ folder. Bundled files are in JSON format.

redocly bundle --output dist --ext json openapi/openapi.yaml openapi/museum.yaml
dist/openapi.json
dist/museum.json

Create a fully dereferenced bundle

A fully dereferenced bundle does not use $ref at all, all the references are resolved and placed into the API description file. This can be useful if you need to prepare an OpenAPI file to be used by another tool that does not understand the $ref syntax.

redocly bundle --dereferenced --output dist --ext json openapi/openapi.yaml openapi/museum.yaml
Note

JSON output only works when there are no circular references.

Custom configuration file

By default, the CLI tool looks for the Redocly configuration file in the current working directory. Use the optional --config argument to provide an alternative path to a configuration file.

redocly bundle --config=./another/directory/config.yaml

Skip preprocessor, rule, or decorator

You may want to skip specific preprocessors, rules, or decorators upon running the command.

  1. Skip preprocessors
  2. Skip rules
  3. Skip decorators
redocly bundle --skip-preprocessor=discriminator-mapping-to-one-of --skip-preprocessor=another-example
Tip

To learn more about preprocessors, rules, and decorators, refer to the custom plugins page.