https://github.com/robertmassaioli/openapi-merge

Merge multiple OpenAPI 3.0 (Swagger) files together via a library or CLI tool.
https://github.com/robertmassaioli/openapi-merge

merge openapi swagger

Last synced: 5 days ago
JSON representation

Merge multiple OpenAPI 3.0 (Swagger) files together via a library or CLI tool.

• Host: GitHub
• URL: https://github.com/robertmassaioli/openapi-merge
• Owner: robertmassaioli
• License: mit
• Created: 2021-05-23T02:23:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-06-06T04:48:25.000Z (7 months ago)
• Last Synced: 2024-10-30T03:43:02.490Z (about 2 months ago)
• Topics: merge, openapi, swagger
• Language: TypeScript
• Homepage:
• Size: 2.15 MB
• Stars: 129
• Watchers: 4
• Forks: 26
• Open Issues: 40
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## 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

![Imgur](https://i.imgur.com/GjnSXCS.png)

(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: [![npm](https://img.shields.io/npm/v/openapi-merge?label=openapi-merge&logo=npm)](https://bit.ly/2WnIytF)

* The openapi-merge CLI tool: [![npm](https://img.shields.io/npm/v/openapi-merge-cli?label=openapi-merge-cli&logo=npm)](https://bit.ly/3bEVq3f)

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][1] 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:

``` shell

bolt install

```

You can then test running the CLI tool by running:

``` shell

yarn 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:

``` shell

bolt 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.

 [1]: https://github.com/boltpkg/bolt