The openapi-merge repository

Welcome to the openapi-merge repository. This library is intended to be used for merging multiple OpenAPI 3.0 files together. The most common reason that developers want to do this is because they have multiple services that they wish to expose underneath a single API Gateway. Therefore, even though this merging logic is sufficiently generic to be used for most use cases, some of the feature decisions are tailored for that specific use case.

Screenshots

(An example of creating an openapi-merge.json configuration file for the CLI tool)

About this repository

This is a multi-package repository that contains:

• The openapi-merge library:
• The openapi-merge CLI tool:

Depending on your use-case, you may wish to use the CLI tool or the library in your project. Please see the readme file of the specific package for more details.

Developing on openapi-merge

This project is a multi-package repository and uses the bolt tool to manage these packages in one development experience.

After checking out this repository, you can run the following command to install the required dependencies:

1bolt install

You can then test running the CLI tool by running:

1yarn cli

If you wish to ensure that you can develop on the openapi-merge library in parallel to the openapi-merge-cli tool then you must run the Typescript build for openapi-merge in watch mode. You can do this by:

1bolt w openapi-merge build -w

This will ensure that the Typescript is compiled into JavaScript so that it can be used by the openapi-merge-cli tool.

For the other operations that you wish to perform, please see the package.json of the other packages in this repository.