liveBook · Manning

Bundling

As explained in Automating API Delivery

Bundling is the technique of combining an API document with the definitions referenced from other files or URLs into a single document.

Bundling combines a multifile OpenAPI definition into one document by resolving references from other files or URLs and consolidating them as internal references. It helps tools that do not support external references consume the definition. section 8.13.2

Use bundling as an automated API-artifact transformation:

  • Keep the source definition modular, then generate a bundled artifact during the CI/CD build or deployment pipeline. section 9.1
  • Treat bundling as distinct from merging: bundling combines one multifile definition, while merging joins multiple standalone definitions. section 9.1
  • Publish the generated artifact for external consumers, developer portals, SDK generation, or later pipeline stages through an API registry or artifact store. section 9.1
cd apis/product-catalog-api
redocly bundle openapi.yaml --output bundled.yaml

Generate bundled.yaml from the product-catalog-api source definition with Redocly CLI. section 8.13.2

How Automating API Delivery covers it

How deep it goes
Defines reference consolidation, distinguishes bundling from merging, and demonstrates a CLI command without detailing reference-resolution internals.
Examples
Uses product-catalog-api, openapi.yaml, bundled.yaml, and the Redocly CLI bundle command as concrete artifacts.
What it assumes
Assumes a multifile OpenAPI definition with external references and basic command-line access to a bundling tool.
What you can do after
Apply it via Redocly CLI or Swagger CLI to generate a single API definition for downstream tools and consumers.
How it connects
Connects bundling to OpenAPI, external references, CI/CD pipelines, API transformations, artifact stores, and API registries.

Also explained in

Compare how 8 books explain bundling →

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.