marcelthole/openapi-merge

Merge multiple OpenAPI YML/JSON files into one

Installs: 33 821

Dependents: 2

Suggesters: 0

Security: 0

Stars: 15

Watchers: 2

Forks: 6

Open Issues: 1

Type:application

2.2.2 2024-08-06 10:18 UTC

This package is auto-updated.

Last update: 2024-11-06 11:21:47 UTC


README

Test Status Docker Build Status codecov Mutation testing badge Latest Stable Version License

Read multiple OpenAPI 3.0.x YAML and JSON files and merge them into one large file.
This application is build on cebe/php-openapi

Installation

composer require marcelthole/openapi-merge

Usage

CLI

$ vendor/bin/openapi-merge --help

Usage:
    openapi-merge basefile.yml additionalFileA.yml additionalFileB.yml [...]  > combined.yml

Arguments

Docker

Run the openapi-merge command within a docker container

docker pull ghcr.io/marcelthole/openapi-merge
docker run -v $PWD:/app --rm ghcr.io/marcelthole/openapi-merge [arguments]

Build the image locally from the sourcecode:

docker build --build-arg COMPOSER_REQUIRE_VERSION=<version> --no-cache -t marcelthole/openapi-merge:dev docker
docker run -v $PWD:/app --rm marcelthole/openapi-merge:dev [arguments]

Outputformat

The output format is determined by the basefile extension.