https://github.com/LimeFlight/openapi-diff
Lib, CLI and GitHub Action to compare two OpenAPI Specification files v3
https://github.com/LimeFlight/openapi-diff
csharp diff dotnet dotnetstandard openapi-specification
Last synced: about 1 year ago
JSON representation
Lib, CLI and GitHub Action to compare two OpenAPI Specification files v3
- Host: GitHub
- URL: https://github.com/LimeFlight/openapi-diff
- Owner: LimeFlight
- License: mit
- Created: 2020-04-10T12:53:02.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-21T12:23:15.000Z (almost 2 years ago)
- Last Synced: 2025-03-11T10:52:44.262Z (over 1 year ago)
- Topics: csharp, diff, dotnet, dotnetstandard, openapi-specification
- Language: C#
- Homepage:
- Size: 355 KB
- Stars: 4
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
OpenAPI-Diff
Compares two OpenAPI documents!
Report Bug
·
Request Feature
Table of Contents
## About The Project
In order to identify any breaking API change of our B2B SaaS solution we created this project to outline the changes in the OpenAPI document.
We are using this together with GitHub Actions ([https://github.com/LimeFlight/openapi-diff-action](https://github.com/LimeFlight/openapi-diff-action)) to highlight changes in every Pull Request.
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
Coming soon.
### Installation
Coming soon.
## Usage
Coming soon.
### CLI
Install globally:
```shell
dotnet tool install --global LimeFlight.OpenAPI.Diff.CLI --version 3.0.9
```
Invoke:
```
openapi-diff --help
```
```
Options:
-o|--old Path to old OpenAPI Specification file
-n|--new Path to new OpenAPI Specification file
-e|--exit Define exit behavior. Default: Fail only if API changes broke backward compatibility
Allowed values are: PrintState, FailOnChanged.
-m|--markdown Export diff as markdown in given file
-c|--console Export diff in console
-h|--html Export diff as html in given file
-?|--help Show help information.
```
**Example:**
```shell
directory="test/LimeFlight.OpenApi.Diff.Test/Resources";
openapi-diff -o $directory/petstore_v2_1.yaml -n $directory/security_diff_1.yaml -m difflog.md
```
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE` for more information.
## Contact
LimeFlight - hello@limeflight.com
Project Link: [https://github.com/LimeFlight/openapi-diff](https://github.com/LimeFlight/openapi-diff)
## Acknowledgements
* [OpenAPITools OpenAPI-diff](https://github.com/OpenAPITools/openapi-diff)
* [Img Shields](https://shields.io)
* [Choose an Open Source License](https://choosealicense.com)
[contributors-shield]: https://img.shields.io/github/contributors/LimeFlight/openapi-diff?style=flat-square
[contributors-url]: https://github.com/LimeFlight/openapi-diff/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/LimeFlight/openapi-diff?style=flat-square
[forks-url]: https://github.com/LimeFlight/openapi-diff/network/members
[stars-shield]: https://img.shields.io/github/stars/LimeFlight/openapi-diff?style=flat-square
[stars-url]: https://github.com/LimeFlight/openapi-diff/stargazers
[issues-shield]: https://img.shields.io/github/issues/LimeFlight/openapi-diff?style=flat-square
[issues-url]: https://github.com/LimeFlight/openapi-diff/issues
[license-shield]: https://img.shields.io/github/license/LimeFlight/openapi-diff?style=flat-square
[license-url]: https://github.com/LimeFlight/openapi-diff/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png