Zuplo CLI

Zuplo CLI: OpenAPI Merge

Merge an OpenAPI file into your Zuplo project

Code

zuplo oas merge --source <file|url> --destination <file> [options]

Common use cases

The command supports importing both JSON and YAML formats. The format is inferred from the file extension.

Code
 
zuplo openapi merge --source /path/to/openapi.json
zuplo openapi merge --source /path/to/openapi.yaml

When no --destination option is provided, the OpenAPI file is automatically merged into routes.oas.json.

To import a remote file, use the --source option with a URL. The command downloads the file to a temporary directory and imports it.

Code
 
zuplo openapi merge --source https://example.com/path/to/openapi.json

To rename the destination file, use the --destination option.

Code
 
zuplo openapi merge --source https://example.com/path/to/openapi.json --destination new-name

Merge an OpenAPI file into your Zuplo project

Code

zuplo oas merge --source openapi.yaml --destination ./config/routes.oas.json

Merge an OpenAPI file from a URL

Code

zuplo oas merge -s https://api.example.com/openapi.json -d ./config/api.oas.json

Merge using operation-id instead of path-method matching

Code

zuplo oas merge --source openapi.yaml --destination ./config/routes.oas.json --merge-mode operation-id

The OpenAPI file to merge (file path or URL)

Type: stringAlias: -s

The destination file name (must end with .oas.json)

Type: stringDefault: "./config/routes.oas.json"Alias: -d

The merge mode to use when merging the OpenAPI file

Type: stringDefault: "path-method"Choices: path-method, operation-idAlias: -m

The following global options are available for all commands:

Last modified on October 22, 2025