The Swagger Merge SDK & CLI tool allows you to process the merging of multiple Swagger files into a single Swagger file. This is useful for bringing together the API layer of a distributed service architecture where you wish to expose the APIs via a single API gateway.
The CLI tool currently supports merging Swagger V2 specification JSON files. It is not yet capable of merging Swagger V3 specification JSON or YAML files.
If you want to just use the tool to merge your Swagger files, you can install and use the Swagger Merge CLI tool.
dotnet tool install -g SwaggerMerge
Or update an existing install
dotnet tool update -g SwaggerMerge
To use the tool, follow the Swagger Merge CLI tool instructions.
If you want to build your own applications on the Swagger Merge SDK that backs the CLI tool, you can install the Swagger Merge SDK into your dotnet application.
dotnet add package SwaggerMerge.SDK
Or by adding the SwaggerMerge.SDK
package in your NuGet package manager of choice.
To use the SDK, follow the Swagger Merge SDK instructions.
Contributions, issues and feature requests are welcome!
Feel free to check the issues page. You can also take a look at the contributing guide.
We actively encourage you to jump in and help with any issues, and if you find one, don't forget to log it!
As many developers know, projects like this are built and maintained in maintainers' spare time. If you find this project useful, please Star the repo.
π€ James Croft
- Website: https://www.jamescroft.co.uk
- Twitter: @jamesmcroft
- Github: @jamesmcroft
- LinkedIn: @jmcroft
This project is made available under the terms and conditions of the MIT license.